Skip to content

docs: describe the pinned reusable workflow - #175

Merged
noctuum merged 4 commits into
mainfrom
docs/pinned-workflow
Oct 31, 2026
Merged

noctuum merged 4 commits into
mainfrom
docs/pinned-workflow

Conversation

@noctuum

@noctuum noctuum commented Oct 31, 2026

Copy link
Copy Markdown
Member

The README, docs/SETUP.md and docs/WORKFLOW.md describe a repository created from the template staticwire/aurtomator-seed that calls the reusable workflows of aurtomator at the SHA of a release tag. The quick start and the setup guide clone aurtomator at the pinned tag into ~/src/aurtomator and run every script from inside the user repository. docs/SETUP.md shows the two calling workflows of the template in full, and a new test in tests/workflows.bats reads them with yq and checks the schedule, the concurrency group, the pins, the permissions, the secrets passed by name and the condition of notify.

docs/WORKFLOW.md describes the workflow_call trigger, the two checkouts at job.workflow_sha, Check the pin, the notify job of the calling workflow, and in a new section 6.4 the validate and pipeline jobs of ci.yml. CONTRIBUTING.md, SECURITY.md, the header of packages/example.yml.sample, the bug report form and a comment in check-updates.yml describe the user repository in place of a fork. The troubleshooting part of docs/SETUP.md covers the Invalid workflow file error of a calling job that grants too few permissions, and no longer says that secret names are case-sensitive. bats tests/ --recursive: 1081 pass.

@noctuum
noctuum merged commit 1ea65c4 into main Oct 31, 2026
13 checks passed
@noctuum
noctuum deleted the docs/pinned-workflow branch October 31, 2026 07:14
@aurtopacker aurtopacker Bot mentioned this pull request Oct 31, 2026
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