docs: fix reference/workflows.md opening snippet to match the shim model#37
Merged
Conversation
Three errors for first-time adopters copying the snippet: - called publish.yml directly (needs the publish-dispatch.yml shim; re-dispatch re-fires the shim by name, so a direct caller gets no tag re-deploy) - granted actions: read (re-dispatch runs gh workflow run, needs write) - used a placeholder if: guard (should be github.repository == 'ORG/REPO') Also clarifies the prose that publish.yml is reached via the shim, not directly. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
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.
Summary
reference/workflows.mdopening snippet that would cause silent failures for first-time adopters copying it:uses: …/publish.yml@<tag>→uses: ./.github/workflows/publish-dispatch.yml—publish.ymlisworkflow_call-only; the re-dispatch re-fires the shim by name, so a consumer callingpublish.ymldirectly gets no tag re-deployactions: read→actions: write— the re-dispatch job runsgh workflow run, which requires writeif: <internal-event + canonical-repo guard>→if: github.repository == 'ORG/REPO'— the fork-warn branch lives insidepublish.yml, not in the callerpublish.ymlis reached via the local shim, not directlyCloses #34 (the "Before you start" docs were already fixed on the
refactor-gather-prioritybranch, now merged).Test plan
ci.ymlsnippet