docs: refresh the release workflow pages for the train-based pipeline#171
Merged
Conversation
The release.en.md / release.fr.md pages still described the pre-split pipeline: a single v*.*.* tag trigger and a two-input dispatch. Bring them up to date with reality — the three release trains and their tag prefixes (lib-v, cli-v, dum-v), the component dispatch input, the train-prefix stripping, the GenDoc major-bump gate in the step chain, per-train packing with its guards, train-scoped release notes, and a pointer to the AddingAReleaseTrain runbook. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UhPrBqngpiSwdsF4DWvNPw
The fact-check against release.yml surfaced an omission: after the GitHub Release, a cli release also refreshes GenDoc's error-catalog baseline (accepting the published contract, pushed straight to main), and that step shares the dry-run gate — so three publish steps are gated, not two. Complete the step chain and correct the gating count in both languages. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UhPrBqngpiSwdsF4DWvNPw
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings the
releaseworkflow reference pages (doc/handwritten/for-maintainers/workflows/release.en.md/.fr.md) back in sync with the pipeline as it exists today: they still described the pre-lib/cli-split era (a singlev*.*.*tag, two dispatch inputs), whilerelease.ymlnow drives three independent release trains and carries the GenDoc gates.Type of change
Changes
lib-v*.*.*with its lockstep package group,cli-v*.*.*,dum-v*.*.*) and the threeworkflow_dispatchinputs (component,version,dry_run), with links totools/trains.shand theAddingAReleaseTrainrunbook.v.lib-v1.2.3;id,lib-v1.2.3+build5); the OIDC bullet's gating claim corrected.AddingAReleaseTrainrunbook.Every claim was fact-checked against
release.yml,pack.sh,release-notes.shandtrains.sh; that check is what surfaced the omitted baseline-refresh step. One residual left untouched to keep this PR documentation-only: the comment insiderelease.ymlitself (around line 236) still says only the push and the Release are dry-run-gated — same staleness, but fixing it is a workflow-file change.Testing
dotnet build FirstClassErrors.slndotnet test FirstClassErrors.slnFirstClassErrors.Analyzers.UnitTests)Documentation-only change (two Markdown pages); no build or test was run locally. CI runs the full suite regardless.
Documentation
doc/updated (maintainer workflow reference, English and French in lockstep)doc/handwritten/for-users/README.fr.md) updated if user-facing behavior changed — not applicable: no user-facing behavior change; the maintainer pages' own French counterpart is updated in this PRArchitecture decisions
Proposed: ADR-____Related issues
None.
🤖 Generated with Claude Code
https://claude.ai/code/session_01UhPrBqngpiSwdsF4DWvNPw
Generated by Claude Code