Skip to content

docs: stop restating runner and CI config in the README #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
altaywtf merged 1 commit into from
Oct 5, 2026
Merged

docs: stop restating runner and CI config in the README #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ commits unreleased until the next push.
- Actionlint and Zizmor run when the range changes `.github/`, action
metadata, Zizmor configuration, or ShellCheck configuration. `zizmor-args`
adds arguments for documented needs, such as `--no-online-audits`. A
repository on Blacksmith or other non-GitHub runner labels lists them in
repository on non-GitHub runner labels lists them in
`.github/actionlint.yaml`.
- Manual dispatch, a new branch, or a previous head that is not an ancestor
scans full history and always lints. Dispatch once after a scanner upgrade.
Expand All @@ -97,10 +97,6 @@ commits unreleased until the next push.
`contents: read`) until the previous head resolves. Zizmor's online audits
use the same token.

Linux runners pull digest-pinned images; macOS runners download
sha256-pinned release binaries. [Pinned versions](#pinned-versions) lists
where each pin lives.

## actions/links

[`actions/links`](.github/actions/links/action.yml) checks relative links and
Expand Down Expand Up @@ -157,6 +153,5 @@ pyflakes publishes no release archives, so its pin is the commit its tag names
After `pnpm install`, `mise run verify` checks that each tool's pins agree,
lints and audits the workflows and actions, and checks Markdown formatting
with oxfmt; `pnpm exec oxfmt '**/*.md'`
fixes findings. [Verify](.github/workflows/verify.yml) runs it on pull
requests, `main`, and manual dispatch, then runs both actions from the same
commit; `gitleaks: true` scans this repository's own pushes.
fixes findings. CI runs it and both actions from the same commit
([`verify.yml`](.github/workflows/verify.yml)).