mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 19:01:54 +00:00
Group the shell helpers under scripts/github/ into five subfolders that match how the workflow files consume them: runner/ host-runner hygiene (disk, swap, Docker daemon, diagnostics) cancel/ run cancellation on PR-close and branch-delete events resolve/ derivation of workflow inputs and outputs from repo state update/ scheduled Update: Versions pipeline release/ release-time gates Drop the now-redundant subfolder prefix from each filename, e.g. dump_runner_state.sh becomes dump_state.sh and cancel_pull_request_runs.sh becomes pull_request_runs.sh. Each subfolder carries a README that describes its scope per documentation.md rules; the top-level README points at the subfolders without inventorying files. Propagate the new paths through ten workflow files, three docs (workflow.md, pipeline.md, secrets.md), and two tests. Fix a real runtime bug in enlarge_swap.sh, which still referenced the pre-rename dump_runner_state.sh path. Extend the inline-block-size lint hint to describe the new subfolder convention. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
18 lines
1.2 KiB
Markdown
18 lines
1.2 KiB
Markdown
# GitHub Workflow Helpers 🔧
|
|
|
|
This directory holds the shell helpers that GitHub Actions workflows under [`.github/workflows/`](../../.github/workflows/) call. Helpers are grouped by responsibility into subfolders so each workflow file pulls only from the clusters it actually needs.
|
|
|
|
## Subfolders 🗂️
|
|
|
|
| Subfolder | Responsibility |
|
|
|---|---|
|
|
| [runner/](runner/) | Host-runner hygiene around image builds and deploys (disk, swap, Docker daemon, diagnostics). |
|
|
| [cancel/](cancel/) | Cancellation of in-progress workflow runs on PR-close and branch-delete events. |
|
|
| [resolve/](resolve/) | Derivation of structured workflow inputs and outputs from repository state. |
|
|
| [update/](update/) | The scheduled `Update: Versions` pipeline (version bumps and PR open/refresh). |
|
|
| [release/](release/) | Release-time gates that decide whether a tagged commit may be released. |
|
|
|
|
A new helper MUST live in the subfolder that matches its responsibility. New responsibilities MAY motivate a new subfolder, but MUST NOT flatten back into the top level.
|
|
|
|
For the workflow catalog see [workflows.md](../../docs/contributing/tools/github/actions/workflows.md). For the repository Make target index see [make.md](../../docs/contributing/tools/make.md).
|