From 1fc7b218653a63bdc6d423e0fa95578e00e8230e Mon Sep 17 00:00:00 2001 From: Jose Celano Date: Tue, 10 Nov 2026 13:23:21 +0000 Subject: [PATCH] docs: add release process pointing to the Tracker's source of truth Co-Authored-By: Claude Sonnet 5.5 --- README.md | 2 ++ docs/release_process.md | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 docs/release_process.md diff --git a/README.md b/README.md index 94f3626..66ba8a1 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ Common functionality used in all Torrust HTTP servers. [Crate documentation](https://docs.rs/torrust-server-lib). +[Release process](docs/release_process.md). + ## License The project is licensed under the terms of the [GNU AFFERO GENERAL PUBLIC LICENSE](./LICENSE). diff --git a/docs/release_process.md b/docs/release_process.md new file mode 100644 index 0000000..42ed006 --- /dev/null +++ b/docs/release_process.md @@ -0,0 +1,21 @@ +# Release process + +This repository holds a single publishable crate, `torrust-server-lib`. + +The process is the one defined for workspace packages in the Torrust Tracker, which is the source +of truth. Follow its +[Publishing a Workspace Package](https://github.com/torrust/torrust-tracker/blob/develop/docs/release_process.md#publishing-a-workspace-package) +section (versioning, changelog, dry run, publish, signed tag). Do not copy it here. + +## Differences in this repository + +- There is no `develop` branch: releases are cut from `main`. +- There is no `deployment-packages.yaml` workflow and no `releases/pkg/**` branches, so the + **manual fallback** of the Tracker document is the only path. +- The tag is `v` (for example `v0.6.0`), not `pkg//v`. + +## Checklist + +1. Merge a PR that bumps `version` in `Cargo.toml` and adds the `CHANGELOG.md` entry. +2. From the merged `main`: `cargo publish --dry-run`, then `cargo publish`. +3. Create the signed tag on the published commit and push it to `torrust/torrust-server-lib`.