docs(readme): correct the versioning claim that Dependabot bumps consumers - #578
Conversation
…umers The §Versioning paragraph justified cutting a release after every meaningful change by claiming Dependabot's `github-actions` group then bumps consumers to the tagged SHA. It does not. Consumers pin this repository by full commit SHA with a `# vX.Y.Z` comment and move that pin through a reviewed pull request in their own repository; at least one consumer's Dependabot config explicitly ignores `melodic-software/ci-workflows/*`. The reason to cut a release is unchanged — it makes a tagged SHA available to pin to — and the `release-gap-check` advisory-issue sentence that follows was already correct and is preserved verbatim, only rewrapped. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01L5ZJnwTRCgc31bmfrdugyU
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
Claude finished @kyle-sexton's task in 2m 9s —— View job Claude finished the code-review lane for PR #578
Verdict: no issues found. Verified independently (not just restating the PR body's own claims):
No correctness, maintainability, or consistency defects found in the diff itself. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9aa1da8dc6
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
Claude has reviewed this PR 1 time. The lane skips further automatic reviews after 5; deleting this comment resets the count. |
The Versioning rewrite states that consumers are never bumped automatically, but the Contract's "Pin by SHA" bullet still told consumers that Dependabot opens weekly bump PRs for these actions. Scope that bullet: consumers keep this repository out of Dependabot's `github-actions` updates and repin by reviewed pull request, so a fix here does not reach them until they repin; Dependabot's `uses:`-only limitation now applies to the third-party actions a consumer does track. Also disambiguate the composite pin-lag paragraph, which described this repository's own Dependabot group moving its self-referencing pins in wording that read as consumer guidance. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01L5ZJnwTRCgc31bmfrdugyU
SECURITY.md still said consumers pick up fixes via an advancing pinned SHA that Dependabot bumps, and told them to keep the `github-actions` Dependabot ecosystem enabled. The README's Versioning and Contract sections say the opposite: consumers keep this repository out of Dependabot's `github-actions` updates and move the pin by reviewed pull request, so a fix landed here reaches a consumer only when it repins. Restate both sentences in those terms and point consumers at this repository's Releases and the `release-gap-check` advisory issue. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01L5ZJnwTRCgc31bmfrdugyU
No related issue: drift found while cutting the v0.24.0 release for PR #577; the correction is small enough to carry on its own PR rather than open an issue first.
Summary
The
## Versioningsection justified the tag-per-change policy with a claimthat is not true of this repository's consumers:
Nothing bumps consumers automatically. Consumers pin
ci-workflowsby full40-character commit SHA with a
# vX.Y.Ztrailing comment, and that pin movesonly through a reviewed pull request in the consumer's own repository. At
least one consumer's Dependabot configuration explicitly ignores
melodic-software/ci-workflows/*, so thegithub-actionsgroup never opens abump PR for this repository at all.
The claim mattered in practice: PR #577 added
timeout-minutesto eight stepsin
.github/workflows/checks.ymland merged at2c1de45, but becauseconsumers pin by SHA and no release existed at that commit, the change reached
no consumer. Believing the README meant believing the change had already
propagated.
SECURITY.mdstated the same two now-corrected claims, that consumers pick upfixes via an advancing pinned SHA Dependabot bumps and that they should keep
the
github-actionsDependabot ecosystem enabled, and is rewritten here to thesame reviewed-repin model.
Fix
Replaced the Dependabot clause with what actually happens, and left the rest of
the paragraph's reasoning intact:
available to pin to, which is the true benefit.
comment, moved by a reviewed PR in the consumer's repository.
release-gap-checksentence was already correct and ispreserved verbatim; it is only rewrapped because the replacement changed the
line boundaries.
SECURITY.md: the## Supported versionsparagraph now says a security fixreaches a consumer only when that consumer repins by reviewed pull request,
names the
release-gap-checkadvisory issue, and tells consumers to watchthis repository's Releases; the Pin by full commit SHA bullet now says to
keep this repository out of Dependabot's
github-actionsupdates with anignoreentry and move the pin by reviewed pull request.The diff is one README paragraph plus two SECURITY.md sentences.
Verification
npx markdownlint-cli2@0.23.2 README.mdagainst the repo's own.markdownlint-cli2.jsonc:Summary: 0 issues in 0 files, exit 0.npx markdownlint-cli2 --config .markdownlint-cli2.jsonc SECURITY.md:Summary: 0 issues in 0 files, exit 0.git diff --statfor the README commits:README.md | 15 +++++++-------,1 file changed, 8 insertions(+), 7 deletions(-).git diff --statfor the SECURITY.md commit:SECURITY.md | 14 +++++++-----,1 file changed, 9 insertions(+), 5 deletions(-).git diff | grep '^+.*[ \t]$'returns no matches, so no trailing whitespacewas introduced.
release-gap-checksentencesurvives word-for-word and only its line wrapping changed.
release.ymlcomputes thenext version from published Releases and creates a tag plus Release at
GITHUB_SHA; nothing in it or in this repository opens a bump PR against aconsumer.
Related
timeout-minuteschange sat unreleased and therefore unreachable by SHA-pinned consumers.
v0.24.0(https://github.com/melodic-software/ci-workflows/releases/tag/v0.24.0)was cut at
2c1de45aa0e1b1489afb8edfebc12cb3a4fa6ac3immediately before thisPR, which is what actually delivers fix(checks): bound each download-heavy step with timeout-minutes #577 to consumers once they repin.
.github/workflows/release.yml. It is deliberately left alone here to keepthis PR to documentation files; it is reported separately as follow-up.
🤖 Generated with Claude Code
https://claude.ai/code/session_01L5ZJnwTRCgc31bmfrdugyU