mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-08 11:46:35 +00:00
kevinveenbirkenbachandClaude Opus 4.7
7d7301614d
Add cli/contributing/changelog/archive: a CLI that trims CHANGELOG.md
to the last N entries (default 7) and writes every older release to
its own file under docs/changelog/ named <padded-semver>-<date>.md
(7.0.0 → 007.000.000-2026-05-08.md). The padded form makes a directory
listing already chronological, and the index in CHANGELOG.md is
rebuilt from the archive directory listing on every run, so it never
drifts away from what is on disk. The tool is idempotent and never
overwrites an existing archive file.
Run the migration once to split the 44-entry CHANGELOG.md into 7
inline entries plus 37 archived per-release files, with the index at
the bottom of CHANGELOG.md linking each archive in descending order.
Add docs/contributing/actions/release.md as the contributor-facing
release procedure (versioning, active window vs. archive, cutting a
release end-to-end, CI hand-off on tag push) and add a docs README
under docs/changelog/ that explains the archive directory layout and
filename schema. Cross-link release.md from pipeline.md and add
"releases" to the actions/ scope description.
Documentation cleanup pass on every page touched in the previous
mapping refactor:
- Remove "is the SPOT for X" / "Single Point of Truth" self-labels
across docs/contributing/, docs/agents/, and docs/changelog/. The
rule in documentation.md forbids self-declared SPOT status; status
is conferred by readers cross-linking, not by the page asserting
it. Rephrase to descriptive phrasing ("This page covers X",
"describes X", "lists X") throughout.
- Drop the orphaned docs/contributing/tools/actions.md duplicate
(101 lines paralleling tools/github/actions/workflows.md, with no
inbound links).
- Fix em-dashes used as thought breaks in dockerfile.md, origin.md,
agents/style.css.md, and suppression.md per documentation.md.
- Unwrap soft-wrapped sentences in iam/common.md, iam/ldap.md,
iam/oidc.md, image/origin.md, requirements.md, and dockerfile.md
so each logical line carries one full sentence.
Add a unit test for the archive CLI under
tests/unit/cli/contributing/changelog/archive/test_main.py covering
_pad_version, _split_into_entries, idempotency, dry-run, no-overwrite
of existing archives, and the multi-run index rebuild.
Quote `# noqa:` in CHANGELOG.md prose with backticks so the
noqa-only-ruff-codes lint does not parse "for" as a non-ruff code.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
113 lines
5.1 KiB
Markdown
113 lines
5.1 KiB
Markdown
# CI Configuration ⚙️
|
|
|
|
This page lists every repository variable that controls GitHub Actions CI behaviour in this repo. For the workflow catalog see [workflows.md](workflows.md); for the CI flow see [pipeline.md](../../../artefact/git/pipeline.md).
|
|
|
|
Repository variables are set under **Settings → Secrets and variables → Actions → Variables**.
|
|
|
|
## Variables 📋
|
|
|
|
| Variable | Workflow | Default (unset) | Set to activate |
|
|
|---|---|---|---|
|
|
| `CI_CANCEL_IN_PROGRESS` | [entry-push-latest.yml](../../../../../.github/workflows/entry-push-latest.yml) | Cancels in-progress runs on new push | `false` to keep in-progress runs alive |
|
|
| `CI_RUN_ON_MAIN` | [entry-push-latest.yml](../../../../../.github/workflows/entry-push-latest.yml) | Pushes to `main` skip CI | `true` to run CI on `main` pushes too |
|
|
| `CI_ENABLE_AUTO_UPDATES` | [update.yml](../../../../../.github/workflows/update.yml), [dependabot-close.yml](../../../../../.github/workflows/dependabot-close.yml) | Update jobs skipped; Dependabot PRs auto-closed | `true` to allow update PRs (workflow-driven and Dependabot) |
|
|
|
|
## `CI_CANCEL_IN_PROGRESS` 🛑
|
|
|
|
Controls whether a new push cancels an already-running CI pipeline on the same branch.
|
|
|
|
**Default behaviour (variable not set or set to any value other than `false`):**
|
|
In-progress runs are cancelled when a new push arrives. This is the recommended setting for most workflows.
|
|
|
|
**To disable cancellation:**
|
|
|
|
1. Open the repository on GitHub.
|
|
2. Go to **Settings → Secrets and variables → Actions**.
|
|
3. Switch to the **Variables** tab.
|
|
4. Click **New repository variable**.
|
|
5. Set **Name** to `CI_CANCEL_IN_PROGRESS` and **Value** to `false`.
|
|
6. Save.
|
|
|
|
**To re-enable cancellation:**
|
|
|
|
Delete the variable or change its value to anything other than `false` (e.g. `true`).
|
|
|
|
**How it works:**
|
|
|
|
```yaml
|
|
cancel-in-progress: ${{ vars.CI_CANCEL_IN_PROGRESS != 'false' }}
|
|
```
|
|
|
|
| Variable value | Expression result | Behaviour |
|
|
|---|---|---|
|
|
| *(not set / empty)* | `'' != 'false'` → `true` | Cancels in-progress runs ✓ |
|
|
| `false` | `'false' != 'false'` → `false` | Does **not** cancel ✓ |
|
|
| `true` | `'true' != 'false'` → `true` | Cancels in-progress runs ✓ |
|
|
|
|
## `CI_RUN_ON_MAIN` 🎯
|
|
|
|
Controls whether pushes to `main` trigger the CI pipeline. Pushes to all other branches covered by the workflow (`feature/**`, `hotfix/**`, `fix/**`, `alert-autofix-*`) are unaffected.
|
|
|
|
**Default behaviour (variable not set or set to any value other than `true`):**
|
|
Pushes to `main` are gated out at the `run-policy` job and CI is skipped.
|
|
|
|
**To enable CI on `main` pushes:**
|
|
|
|
1. Open the repository on GitHub.
|
|
2. Go to **Settings → Secrets and variables → Actions**.
|
|
3. Switch to the **Variables** tab.
|
|
4. Click **New repository variable**.
|
|
5. Set **Name** to `CI_RUN_ON_MAIN` and **Value** to `true`.
|
|
6. Save.
|
|
|
|
**To disable again:**
|
|
|
|
Delete the variable or change its value to anything other than `true`.
|
|
|
|
**How it works:**
|
|
|
|
The gate is applied inside [push_ci_policy.sh](../../../../../scripts/meta/resolve/push_ci_policy.sh), which the `run-policy` job invokes. When `GITHUB_REF == refs/heads/main` and `CI_RUN_ON_MAIN != 'true'`, the job emits `should_run=false` and every downstream job is skipped.
|
|
|
|
| Variable value | Ref is `main` | Behaviour |
|
|
|---|---|---|
|
|
| *(not set / empty)* | yes | CI skipped ✓ |
|
|
| `true` | yes | CI runs ✓ |
|
|
| any other value | yes | CI skipped ✓ |
|
|
| *(any)* | no | Unaffected (CI runs per branch rules) ✓ |
|
|
|
|
## `CI_ENABLE_AUTO_UPDATES` 🔄
|
|
|
|
Controls whether automated update PRs are created. Covers both the workflow-driven jobs in [update.yml](../../../../../.github/workflows/update.yml) (Docker image versions, agent skills) and PRs opened by Dependabot (gated via [dependabot-close.yml](../../../../../.github/workflows/dependabot-close.yml), which auto-closes them).
|
|
|
|
**Default behaviour (variable not set or set to any value other than `true`):**
|
|
The `update-docker-image-versions` and `update-skills` jobs are skipped. Dependabot PRs are auto-closed on open with a comment pointing to this variable.
|
|
|
|
**To enable update PRs:**
|
|
|
|
1. Open the repository on GitHub.
|
|
2. Go to **Settings → Secrets and variables → Actions**.
|
|
3. Switch to the **Variables** tab.
|
|
4. Click **New repository variable**.
|
|
5. Set **Name** to `CI_ENABLE_AUTO_UPDATES` and **Value** to `true`.
|
|
6. Save.
|
|
|
|
**To disable again:**
|
|
|
|
Delete the variable or change its value to anything other than `true`.
|
|
|
|
**How it works:**
|
|
|
|
In [update.yml](../../../../../.github/workflows/update.yml) each job carries a job-level guard:
|
|
|
|
```yaml
|
|
if: vars.CI_ENABLE_AUTO_UPDATES == 'true'
|
|
```
|
|
|
|
Dependabot cannot read repository variables itself, so [dependabot-close.yml](../../../../../.github/workflows/dependabot-close.yml) listens on `pull_request_target` (`opened`, `reopened`) and closes any PR authored by `dependabot[bot]` while `CI_ENABLE_AUTO_UPDATES != 'true'`. The workflow does not check out PR code, which keeps the elevated `pull_request_target` context safe.
|
|
|
|
| Variable value | Workflow update jobs | Dependabot PRs |
|
|
|---|---|---|
|
|
| *(not set / empty)* | Skipped ✓ | Auto-closed on open ✓ |
|
|
| `true` | Run ✓ | Stay open ✓ |
|
|
| any other value | Skipped ✓ | Auto-closed on open ✓ |
|