docs: add CONTRIBUTING.md with anchor checksum update process#52
Open
kitsuyui wants to merge 1 commit into
Open
docs: add CONTRIBUTING.md with anchor checksum update process#52kitsuyui wants to merge 1 commit into
kitsuyui wants to merge 1 commit into
Conversation
Documents the manual steps required when bumping the pinned gibo version: download the new checksums.txt and checksums.windows.txt from the upstream release, compute their SHA256 hashes, and update the two anchor values in action.yml alongside the version change. Without this documentation, contributors who receive a Renovate PR that updates only the version line have no written procedure for the required anchor update, causing CI to fail with no clear explanation.
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
1 participant
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.
Why
When Renovate (or a contributor) bumps the pinned gibo
versioninaction.yml,two SHA256 anchor values —
checksums_txt_sha256andchecksums_windows_txt_sha256—must also be updated to match the new release. Renovate's custom manager only updates
the
versionline; it cannot update the anchor hashes. Leaving them stale causes theaction's anchor verification step to fail on the first CI run after a version bump.
No written procedure for this update existed in the repo:
CONTRIBUTING.mdwas absent,and
README.md's Security model section explained the why but not the how.What changed
CONTRIBUTING.mdwith a step-by-step guide for bumping the gibo version:checksums.txtandchecksums.windows.txtfrom the new release.sha256sum(orshasum -a 256on macOS).action.yml(version,checksums_txt_sha256,checksums_windows_txt_sha256).Verification
typos CONTRIBUTING.md— no spelling errors.check-pr-collateral.py) — clean, no violations.action.ymlchanges; the Example workflow CI is unaffected by a documentation-only commit.