Skip to content

docs: fix reference/workflows.md opening snippet to match the shim model#37

Merged
coretl merged 1 commit into
mainfrom
docs-fix-workflow-reference
Jun 30, 2026
Merged

docs: fix reference/workflows.md opening snippet to match the shim model#37
coretl merged 1 commit into
mainfrom
docs-fix-workflow-reference

Conversation

@coretl

@coretl coretl commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fixes three errors in the reference/workflows.md opening snippet that would cause silent failures for first-time adopters copying it:
    • uses: …/publish.yml@<tag>uses: ./.github/workflows/publish-dispatch.ymlpublish.yml is workflow_call-only; the re-dispatch re-fires the shim by name, so a consumer calling publish.yml directly gets no tag re-deploy
    • actions: readactions: write — the re-dispatch job runs gh workflow run, which requires write
    • if: <internal-event + canonical-repo guard>if: github.repository == 'ORG/REPO' — the fork-warn branch lives inside publish.yml, not in the caller
  • Clarifies the opening prose to note that publish.yml is reached via the local shim, not directly

Closes #34 (the "Before you start" docs were already fixed on the refactor-gather-priority branch, now merged).

Test plan

  • Check the rendered reference page matches the tutorial's ci.yml snippet

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>
@coretl coretl merged commit 860fb84 into main Jun 30, 2026
7 checks passed
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.

Make 'Before you start' documentation clearer

1 participant