ci: correct stale comments across the release and automation workflows#172
Merged
Conversation
Three comments (the dry_run input rationale, its description string, and the OIDC-login block) predated the GenDoc PR's baseline-refresh step: they said only the NuGet push and the GitHub Release are gated off on a dry run, when a cli release also gates a third publish step, the error-catalog baseline refresh. The input rationale additionally listed the OIDC login among the skipped steps, though it runs on every trigger by design. Comments only; no behavior change.
A consistency pass over the rest of release.yml's comments: - the lib-train mapping omitted FirstClassErrors.RequestBinder in two places (the tag-trigger reference and the Pack comment), though pack.sh and trains.sh publish it on the lib train; - the contents:write justification named only the GitHub Release, but the scope also serves the cli baseline-refresh step's push to main; - reordered the dry-run rationale to list the attestation and the OIDC login in execution order. Comments only; no behavior change.
- The lib-train changelog mapping omitted FirstClassErrors.RequestBinder, though trains.sh, pack.sh and collect-prs.sh all publish it on the lib train. - The from_ref note claimed the value is only handed to 'git log', but collect-prs.sh also passes it to 'git rev-parse' for validation; say git (rev-parse, then log) instead. Comments only; no behavior change.
The header labelled the workflow 'Palier A', a French term (against the repo's English-only rule) and an orphaned tier label used nowhere else. Reword to the authoritative maintainer doc's phrasing, 'the low-friction lane of the Dependabot automation policy'. Comment only; no behavior change.
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
A comments-only consistency pass over
release.ymland its neighbouring workflows: several comments predated the lib/cli/dum train split, the GenDoc baseline-refresh step, and the binder joining the lib train, so they no longer matched the code they describe. No workflow behaviour changes — every edited line is a#comment or adescription:string (verified: the whole-branch diff contains no non-comment change).Type of change
Changes
release.yml:dry_runinput rationale, itsdescription, and the OIDC-login block) said only the NuGet push and the GitHub Release are gated off on a dry run; a cli release also gates a third publish step, the error-catalog baseline refresh. Corrected in all three spots, and the OIDC login is no longer listed among the skipped steps (it runs on every trigger by design).FirstClassErrors.RequestBinderin two places (the tag-trigger reference and the Pack comment).contents: writejustification named only the GitHub Release, but the scope also serves the cli baseline-refresh step's push tomain.changelog.yml:FirstClassErrors.RequestBinder.from_refnote claimed the value only reachesgit log, butcollect-prs.shalso passes it togit rev-parse.dependabot-automerge.yml:The remaining neighbouring workflows (
ci,gendoc-docs,canary,release-dryrun,analyzers,adr-check,sonar,scorecard,dependency-review,codeql,commit-lint) were reviewed and found factually consistent; they are not touched.Testing
dotnet build FirstClassErrors.slndotnet test FirstClassErrors.slnFirstClassErrors.Analyzers.UnitTests)Comments-only change to workflow YAML — no build or test was run locally (there is no runtime surface to exercise). Each touched file was parsed as YAML and the diff was checked to contain only comment/
descriptionlines. CI runs the full suite regardless.Documentation
doc/updateddoc/handwritten/for-users/README.fr.md) updated if user-facing behavior changedreleaseworkflow reference pages were refreshed separately in docs: refresh the release workflow pages for the train-based pipeline #171; this PR corrects the comments inside the workflow files themselves.Architecture decisions
Proposed: ADR-____Related issues
Follow-up to #170 (the dum release train) and #171 (the release workflow doc refresh).
🤖 Generated with Claude Code
https://claude.ai/code/session_01UhPrBqngpiSwdsF4DWvNPw
Generated by Claude Code