docs: recommend pinning runtime_ref to a gateway commit SHA#1
Open
saubyk wants to merge 1 commit into
Open
Conversation
A SHA-pinned uses: fixes the action code but resolves the runtime at runtime_ref, which defaults to a movable tag — so a re-tagged runtime can change what runs with no consumer PR. Document pinning both axes (action SHA + runtime_ref SHA) in templates/gateway.yml, README, and architecture.md. Surfaced by calvinrzachman in lightningnetwork/lnd#10910.
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.
Recommends pinning both version axes in consumer shims: the
uses:action SHA andruntime_refto a gateway runtime commit SHA.Why
A SHA-pinned
uses:fixes the action code, but the action checks out the private runtime atruntime_ref, which defaults to a movable tag. So a re-tagged runtime could change what runs on a consumer with no PR. Pinningruntime_refto a commit SHA closes that, routing runtime upgrades through review the same way the action pin already does.Surfaced by @calvinrzachman reviewing the lnd shim (lightningnetwork/lnd#10910).
Changes
templates/gateway.yml— add a pinnedruntime_refline + customize note.README.md— example gainsruntime_ref; revise the "single version axis" framing to recommend two pins.docs/architecture.md— same correction to the versioning note.Docs only — no behavior change.