Pin GitHub Actions to full-length commit SHAs - #309
Conversation
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
This comment has been minimized.
This comment has been minimized.
ranm-msft
left a comment
There was a problem hiding this comment.
Thanks for this - I verified the mechanical substance rather than skimming it.
Every pinned SHA is correct. For each uses: I resolved the pinned commit through the GitHub API (dereferencing annotated tag objects to their commits) and confirmed it matches the tag its comment claims:
actions/checkout@11d5960= v4.4.0tj-actions/changed-files@48d8f15= v45.0.2DavidAnson/markdownlint-cli2-action@db43aef= v17.0.0check-spelling/check-spelling@cfb6f7e= v0.0.26
I also compared each pinned SHA against what the original floating ref resolves to today - all identical. So this is behavior-preserving: no silent downgrade, no version drift. I checked coverage too, and duplicate-surfacing.lock.yml was already fully pinned (53/53), so the repo is complete after this.
One thing blocking merge:
Check Spelling is failing on this PR, and the newly added file is the cause:
.github/dependabot.yml:10 `cooldown` is not a recognized word (unrecognized-spelling)
The config itself is fine - cooldown / default-days is valid, documented Dependabot syntax. The repo's dictionary just doesn't know the word. Adding cooldown to .github/actions/spelling/expect/generic_terms.txt should turn it green.
Since you're rolling this out across many repos, this likely reproduces anywhere check-spelling is enabled - is it worth folding into the campaign template so each owner doesn't hit it separately?
Happy to approve as soon as the check is green.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
ranm-msft
left a comment
There was a problem hiding this comment.
Approved.
I re-verified all four SHA/version mappings at the new head, and they all still match what their comments claim:
actions/checkout@11d5960= v4.4.0tj-actions/changed-files@48d8f15= v45.0.2DavidAnson/markdownlint-cli2-action@db43aef= v17.0.0check-spelling/check-spelling@cfb6f7e= v0.0.26
The only delta since my earlier review is Demitrius Nelon (@denelon)'s follow-up commit, and it is a single line adding cooldown to .github/actions/spelling/expect/generic_terms.txt - exactly the fix that was needed. Check Spelling is green now, alongside Report (PR) and license/cla.
That clears the one thing I had flagged, so this is good to go from my side. Thanks for the clean, well-documented change, and for the verification steps in the description - they made this quick to confirm rather than take on faith.
Summary
This PR pins GitHub Actions to full-length commit SHAs for improved security and reproducibility and adds a 7 day cooldown to Dependabot configuration for GitHub Actions. This work is described in more detail at https://aka.ms/action-pinning.
Why?
Pinning actions to commit SHAs prevents supply-chain attacks where a tag could be moved to point to malicious code. This is a recommended security best practice per the GitHub Actions security hardening guide.
This change mitigates the risk of tag retargeting to malicious code as seen in incidents like the tj-actions/changed-files action compromise or codfish/semantic-release-action compromise and improves the integrity and reproducibility of the CI/CD pipeline.
What changed?
Action pinning: Third-party action references in
.github/workflows/that used mutable tag-based references (e.g.,actions/checkout@v4) have been updated to full-length commit SHAs with a version comment (e.g.,actions/checkout@<sha> # v4) using the pinact tool. References that were already pinned to a SHA, or that used immutable release tags, were left unchanged.Dependabot configuration:
.github/dependabot.ymlhas been updated to ensure agithub-actionspackage-ecosystem section is present with acooldownconfiguration (default-days: 7). If the file did not exist, it was created. If agithub-actionssection already existed, only thecooldownblock was added or itsdefault-daysvalue was increased to 7 if it was lower. The 7-day cooldown provides a window for the community to detect and report compromised releases before they are automatically proposed as updates, reducing exposure to supply-chain attacks via newly published malicious versions.Is this safe to merge?
Yes. The pinned SHAs correspond to the same commits that the existing tags pointed to. No behavioral changes in action execution are introduced. You can verify the pinned SHA value using the GitHub REST API (e.g., the commit hash for
actions/checkout@v7can be found in theshaproperty in the JSON response forGET https://api.github.com/repos/actions/checkout/commits/v7).Additional Information
For more information, please see https://aka.ms/action-pinning
Microsoft Reviewers: Open in CodeFlow