Skip to content

docs: replace the release checklist with the pointer to the Tracker process - #10

Merged
josecelano merged 1 commit into
torrust:mainfrom
josecelano-bot:9-release-docs-pointer
Nov 13, 2026
Merged

josecelano merged 1 commit into
torrust:mainfrom
josecelano-bot:9-release-docs-pointer

Conversation

@josecelano-bot

Copy link
Copy Markdown
Contributor

Related to #9

Part 2 of #9: replaces the three-step release checklist in docs/release_process.md with the pointer to the Torrust Tracker's Releasing Workspace Packages (torrust/torrust-tracker#2808), and keeps only this repository's differences (releases from main, manual publish, v<semver> tag).

I use Related to, not Closes, because part 1 of #9 (the tags for 0.1.0 to 0.5.0) is for the maintainer to push.

Checks: markdownlint and cspell pass on the changed file.

🤖 Generated with Claude Code

…rocess

Point to the new Releasing Workspace Packages document of the Torrust
Tracker and drop the three-step checklist that repeated its steps.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@josecelano

Copy link
Copy Markdown
Member

ACK d62b559

@josecelano josecelano self-assigned this Nov 12, 2026
@josecelano
josecelano requested review from da2ce7 and a balanced review from Copilot November 12, 2026 16:22

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues block the documentation-only update to centralize release guidance while retaining repository-specific differences.

No open issues 🎉

What changed in this PR

Addresses the documentation portion of #9 by making the Tracker release process the single source of truth for torrust-server-lib. Historical release-tag backfilling remains separate.

Changes:

  • Updates the link to “Releasing Workspace Packages” and directs maintainers to its standalone-crate section.
  • Removes the duplicated checklist while preserving repository-specific differences: releases from main, manual publication, and v<semver> tags.
File Description
docs/​release_process.md Replaces the release checklist with the shared process link and local differences.

Review effort: Balanced

@da2ce7 da2ce7 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed at d62b559067486047d032cc2910074081269f9793.

Process: this repository has no skills of its own, so the tracker's release-workspace-package (which names this crate as its standalone example), commit-changes and open-pull-request skills were applied by analogy.

The change against its claim: the new link resolves at the tracker's develop (388faf59a) to docs/release-process/workspace-packages.md, titled as the link says, and lines 5–8 are identical to the text its "Pointing to This Process from Package Documentation" section prescribes. Its "Standalone-Repository Crate" section is the procedure for this crate. Each listed difference holds: every merge lands on main; ci.yaml is the only workflow and has no publish job; tags v0.1.0 to v0.6.0 exist on the commits of the issue's table. No step of the deleted checklist is lost: version and changelog are precondition 2, tests 3, dry run 4, publish and tag standalone steps 2 and 3.

Earlier findings on the merged PR 8: F1, F2 and F5 are resolved (the parenthetical and the checklist are gone, and line 14 now names the section whose step 3 is the tag); F3 is left (line 12 and ci.yaml untouched); F4 is moot, as the tags now exist, pushed outside this PR; F6 is left and carried as F2 below.

Hygiene: Conventional subject (75 characters) equal to the title; the body matches the diff; author equals committer; one attribution footer line, as on earlier commits here (no rule in the repository on it). git diff --check is clean. Related to #9 was right when opened, as part 1 was the maintainer's; those tags now exist, so after merge the issue can be closed by hand.

Findings: F1 (Nit) and F2 (Suggestion), inline; none blocks.

Checked, no finding: the README line resolves and follows the pattern of the line above it; one [package], no [workspace], publish = true; the old #publishing-a-workspace-package anchor still resolves to a moved-section stub.

On the loop's compute node at this head: cargo +nightly fmt --check and linter all exit 0, the tests pass (9 passed, 0 failed) and the tree is left clean.

Comment thread docs/release_process.md
section (versioning, changelog, dry run, publish, signed tag). Do not copy it here.
Releases follow the process defined for workspace packages in the Torrust Tracker, which is the
source of truth:
[Releasing Workspace Packages](https://github.com/torrust/torrust-tracker/blob/develop/docs/release-process/workspace-packages.md).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Suggestion][F2] The target's dependent-manifest step has no counterpart here.

Precondition 2 of the linked document (both variants) asks to raise the crate's requirement "in every manifest that depends on it" in the same PR, keeping each path. This crate's dependents live in the tracker and take it from crates.io: at develop the root Cargo.toml (line 114) and four packages pin 0.6.0. For this crate the step is a tracker PR opened after the publish, since a requirement on an unpublished version does not resolve. A fourth difference saying so (or the same line in the target's standalone section, for every standalone crate) would close the loop; this carries the earlier F6.

Comment thread docs/release_process.md
- 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.
"Standalone-Repository Crate" section of the Tracker document is the only path (manual publish).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Nit][F1] Link the section rather than only quoting its name.

The target has ### Standalone-Repository Crate (line 118), slug standalone-repository-crate, unique in the file. The document link lands on ## Publishing a Workspace Package and its deployment-packages.yaml note, which this line rules out; …/workspace-packages.md#standalone-repository-crate would take the reader straight to the four steps that apply. The line already depends on the heading's name, so the anchor adds no coupling.

@da2ce7

da2ce7 commented Nov 12, 2026

Copy link
Copy Markdown

ACK d62b559

1 similar comment
@josecelano

Copy link
Copy Markdown
Member

ACK d62b559

@josecelano
josecelano merged commit d305a5f into torrust:main Nov 13, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants