Repository navigation
docs(actions): GitHub Actions setup and usage guide, generated tables, docs-sync rule - #75
Merged
Merged
Conversation
…, docs-in-same-PR rule Extend docs/GITHUB_ACTIONS.md into a setup and usage guide (prerequisites, quick start, choosing a ref/version, per-action reference, recipes, pinning, troubleshooting, real example). Inputs/outputs tables are generated from actions/*/action.yml by scripts/gen-actions-docs.sh; CI and ci-local.sh run it with --check. Add a docs-in-the-same-PR rule with a code-area-to-doc map to AGENTS.md and CONTRIBUTING.md, and PR template checklist items. Fix stale docs: check@v0.1.0-rc.3 is broken for consumers (#65), so quick starts use setup+drift+lint at that tag; correct version comments on pinned SHAs (checkout v7.0.1, cache v4.3.0, upload-artifact v7.0.2); setup's version description after #66; document that latest resolves only stable releases. Closes #74 Signed-off-by: Ilan Harel <ilan@Ilans-MacBook-Pro.local>
ilanh
force-pushed
the
docs/github-actions-guide
branch
from
November 9, 2026 11:33
d45f6af to
d09a0cf
Compare
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.
What and why
Turns
docs/GITHUB_ACTIONS.md(extended in place, no new file) into a setup and usage guide for the shared actions, and adds guardrails so docs stay in sync with code.Closes #74
Guide (
docs/GITHUB_ACTIONS.md): prerequisites, copy-paste quick start, choosing a ref/version (release tag vs@main+version: sourcevslatest, which resolves only stable releases and none exist yet), pinning and permissions, per-action reference, recipes (PR gate with strict drift/providers/profiles-dir, monoreporoot/paths, generate + artifact, image build with the generated policy, diff-logs withdeny-stale), the real example in ilanh/openspell-python-tester, troubleshooting, and how to change an action.Docs sync
scripts/gen-actions-docs.shgenerates every action's inputs/outputs table fromactions/*/action.ymlbetween<!-- BEGIN/END actions-docs <name> -->markers.--checkfails on stale tables, on an action with no section, or on a section for an action that no longer exists. It runs inci.yml(checkjob) andscripts/ci-local.sh.AGENTS.md: "Docs must be updated in the same PR" with a code-area → doc table;CONTRIBUTING.mdanddocs/DEVELOPING.mdpoint to it.Stale docs fixed
actions/check@v0.1.0-rc.3, which still has the actions/check is broken for external consumers (uses ./actions/... paths) #65 bug for consumers. They now usesetup+drift+lintat that tag and saycheckneedsmainor a later release.actions/checkout@3d3c42e…is v7.0.1 (not v4.2.2),actions/cache@0057852…is v4.3.0,actions/upload-artifact@cf430e0…is v7.0.2 (checked against the tags). Comments only; SHAs unchanged.setup/checkversiondescriptions still saidsourcebuilds the checked-out repository (changed in fix(actions): make check work for external consumers #66).install-dirandcachedescriptions now state the real default and cache key.Checklist
docs/and commits are signed off (git commit -s)scripts/gen-docs.sh --checkandscripts/gen-actions-docs.sh --checkpass; shellcheck and actionlint clean--checkverified to fail on a renamed input and on an action without a sectionCHANGELOG.mdhas a line under## [Unreleased]