Skip to content

docs(readme): add SHA-pinning section for strict supply-chain policies - #7

Merged
nerdalytics merged 1 commit into
trunkfrom
docs/sha-pinning-guidance
Apr 20, 2026
Merged

nerdalytics merged 1 commit into
trunkfrom
docs/sha-pinning-guidance

Conversation

@nerdalytics

Copy link
Copy Markdown
Owner

Adds a Quickstart-adjacent section explaining when and how to pin this action by commit SHA instead of the tag @v1.

This matters for repos with a GitHub Actions policy that rejects tag-only refs (e.g., the nerdalytics org rule that rejects @v1 with 'Actions must be pinned to a full-length commit SHA'). The Marketplace "Use latest version" button hands out a tag-pin by default, which such repos cannot use.

The new section covers:

  • The exact rejection error users will see
  • How to resolve the commit SHA via the GitHub UI (tags/releases page)
  • How to resolve via gh api repos/.../commits/v1.0.1 --jq .sha
  • Tradeoff between pinning to an exact release vs the floating v1

After merge, I'll cut v1.0.2 so the Marketplace listing picks up the new README.

Adds a Quickstart-adjacent section explaining when and how to pin by
commit SHA instead of tag. Matters for repos with a GitHub Actions
policy that rejects tag-only refs (e.g., nerdalytics org rule that
rejects `@v1` with 'Actions must be pinned to a full-length commit
SHA'). Shows how to resolve the SHA both via the GitHub UI and via
the gh CLI, and explains the exact-release vs floating-major tradeoff.
@nerdalytics
nerdalytics merged commit 0d95f1e into trunk Apr 20, 2026
3 checks passed
@nerdalytics
nerdalytics deleted the docs/sha-pinning-guidance branch April 20, 2026 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant