@futurelastic/colab-handbook 1.21.0-rc.1 → 1.21.0-rc.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/audit/audit.mjs +32 -1
- package/package.json +1 -1
- package/templates/README.md +51 -18
- package/templates/ci-call.yml +5 -3
- package/templates/ci-laravel.yml +128 -682
- package/templates/ci-node.yml +88 -676
- package/templates/ci-python.yml +104 -644
- package/templates/release-auto.yml +148 -50
- package/tools/colab +368 -69
- package/tools/lib/blocked-by.js +3 -1
- package/tools/lib/checklist.js +12 -3
- package/tools/lib/ci-cure.js +47 -1
- package/tools/lib/ci-grant.js +61 -11
- package/tools/lib/ci-wait.js +2 -0
- package/tools/lib/codec/labels.d.ts +1 -1
- package/tools/lib/codec/labels.js +5 -2
- package/tools/lib/config-set.js +1 -1
- package/tools/lib/gate-drift.js +3 -1
- package/tools/lib/git.js +32 -2
- package/tools/lib/release-only.js +182 -0
- package/tools/lib/stamp.js +15 -9
- package/tools/lib/template-roundtrip.js +7 -4
- package/tools/lib/template-trunk.js +23 -1
- package/tools/lib/trust-humans.js +46 -1
package/audit/audit.mjs
CHANGED
|
@@ -149,6 +149,8 @@ const treeGreenLib = require("../tools/lib/tree-green.js");
|
|
|
149
149
|
const docsOnlyLib = require("../tools/lib/docs-only.js");
|
|
150
150
|
// #503: `ship-gate-workflows:` / `ship-ignore-workflows:` — read through the same module ship's CI gate uses.
|
|
151
151
|
const verifyRunsLib = require("../tools/lib/verify-runs.js");
|
|
152
|
+
// #736: `release-only-checks:` — read through the same module ship's release-only door uses.
|
|
153
|
+
const releaseOnlyLib = require("../tools/lib/release-only.js");
|
|
152
154
|
// #410: the optional `gate:` block — read through the same module the skills name.
|
|
153
155
|
const gateLib = require("../tools/lib/gate.js");
|
|
154
156
|
// #417: CLAUDE.md as a thin shell over AGENTS.md — the @-import resolver and the tool-block table,
|
|
@@ -268,7 +270,11 @@ function parseScalarValue(raw) {
|
|
|
268
270
|
return val;
|
|
269
271
|
}
|
|
270
272
|
|
|
271
|
-
const NESTED_MAP_KEYS = new Set(["release", "owner", "gate", "thresholds", "contention"]); // owner: #394 · gate: #410 · thresholds: #560 · contention: #630
|
|
273
|
+
const NESTED_MAP_KEYS = new Set(["release", "owner", "gate", "thresholds", "contention", "release-only-checks"]); // owner: #394 · gate: #410 · thresholds: #560 · contention: #630 · release-only-checks: #736
|
|
274
|
+
// #736: the one map whose KEYS are free text — a check's display name ("Install smoke", "CI / install (*)"),
|
|
275
|
+
// optionally quoted, never containing ":" — and whose every value is an INLINE list of paths. Still one
|
|
276
|
+
// level, still no block list: any other line under it is a finding.
|
|
277
|
+
const FREE_KEY_MAP_KEYS = new Set(["release-only-checks"]);
|
|
272
278
|
// The one map whose pairs may hold an INLINE list (`coupled: [a, b]`) — still one level, still no block list (#630).
|
|
273
279
|
const LIST_IN_MAP_KEYS = new Set(["contention"]);
|
|
274
280
|
// A key whose empty value may open EITHER a block list or a one-level map: `migrations:` is a list of
|
|
@@ -295,6 +301,19 @@ function parseFlatYaml(text) {
|
|
|
295
301
|
out[listKey].push(parseScalarValue(item[1]));
|
|
296
302
|
return;
|
|
297
303
|
}
|
|
304
|
+
if (mapKey !== null && FREE_KEY_MAP_KEYS.has(mapKey) && !item) {
|
|
305
|
+
const fp = line.match(/^(\s+)("[^"]+"|'[^']+'|[^\s#"'][^:#]*?)\s*:\s*(.*)$/);
|
|
306
|
+
const fpVal = fp ? fp[3].replace(/\s+#.*$/, "").trim() : "";
|
|
307
|
+
if (fp && (mapIndent === null || fp[1].length === mapIndent) && /^\[.*\]$/.test(fpVal)) {
|
|
308
|
+
if (mapIndent === null) mapIndent = fp[1].length;
|
|
309
|
+
if (out[mapKey] === null || typeof out[mapKey] !== "object") out[mapKey] = {};
|
|
310
|
+
const inner = fpVal.slice(1, -1).trim();
|
|
311
|
+
out[mapKey][fp[2]] = inner === "" ? [] : inner.split(",").map((x) => parseScalarValue(x));
|
|
312
|
+
return;
|
|
313
|
+
}
|
|
314
|
+
problems.push(`line ${idx + 1}: "${mapKey}:" takes one level of "<check name>: [paths]" pairs, each list inline — nothing deeper, no block list`);
|
|
315
|
+
return;
|
|
316
|
+
}
|
|
298
317
|
const pair = line.match(/^(\s+)([A-Za-z0-9_.-]+)\s*:\s*(.*)$/);
|
|
299
318
|
if (mapKey !== null && pair && !item) {
|
|
300
319
|
const [, indent, sub, subRaw] = pair;
|
|
@@ -1600,6 +1619,18 @@ function auditRepoInner(target, ctx) {
|
|
|
1600
1619
|
for (const why of vp.problems) fail(why);
|
|
1601
1620
|
}
|
|
1602
1621
|
|
|
1622
|
+
// ---- release-only-checks (#736) ---------------------------------------------
|
|
1623
|
+
// Checks that matter only to a release, each next to the paths it covers: ship's per-branch
|
|
1624
|
+
// release-only door lets a branch past a trunk red only on them when it touches none of those
|
|
1625
|
+
// paths. An invalid declaration fails: the reader ignores the whole key, so it exempts nothing.
|
|
1626
|
+
{
|
|
1627
|
+
const ro = releaseOnlyLib.parseReleaseOnly(cfg);
|
|
1628
|
+
info.releaseOnlyChecks = ro.declared && ro.valid
|
|
1629
|
+
? ro.checks.map((c) => ({ check: c.key, workflow: c.workflow, job: c.job, paths: c.paths }))
|
|
1630
|
+
: null;
|
|
1631
|
+
for (const why of ro.problems) fail(why);
|
|
1632
|
+
}
|
|
1633
|
+
|
|
1603
1634
|
// ---- gate (#410) ----------------------------------------------------------
|
|
1604
1635
|
// Local = a fast smoke check, branch CI = the one authoritative gate. tools/lib/gate.js
|
|
1605
1636
|
// parseGate is the one reading. An invalid block fails: the reader falls back to the local full
|
package/package.json
CHANGED
package/templates/README.md
CHANGED
|
@@ -4,8 +4,9 @@ Starting points you **copy into your own repo**. That is the entire model.
|
|
|
4
4
|
|
|
5
5
|
> **These are NOT called remotely — with two exceptions.** `instruction-files.yml` is a caller:
|
|
6
6
|
> its one job `uses:` this handbook's reusable `.github/workflows/instruction-files.yml` (#588,
|
|
7
|
-
> kept for compatibility — see *Where each file lives* below).
|
|
8
|
-
>
|
|
7
|
+
> kept for compatibility — see *Where each file lives* below). The light CI templates are the other:
|
|
8
|
+
> `ci-node.yml`, `ci-python.yml`, `ci-laravel.yml` (since #724) and the generic `ci-call.yml` call the
|
|
9
|
+
> reusable light lane `.github/workflows/ci-light.yml`, pinned to a release tag (#721 — see
|
|
9
10
|
> *The reusable light lane* below). Every other file here is copied, not called. (`dist-refs.yml` is a
|
|
10
11
|
> `workflow_call` workflow, but its caller is your own release workflow, in the same repo, via
|
|
11
12
|
> `uses: ./.github/workflows/dist-refs.yml` — the file still lives, in full, where it runs.) An earlier version of this
|
|
@@ -103,13 +104,13 @@ check that reads one of these files is that tool's behaviour, documented with th
|
|
|
103
104
|
|
|
104
105
|
| File | Copy to | For | Notes |
|
|
105
106
|
|---|---|---|---|
|
|
106
|
-
| `ci-call.yml` | `.github/workflows/ci.yml` |
|
|
107
|
-
| `ci-node.yml` | `.github/workflows/ci.yml` | Pure Node repos: Vite SPA, node libs, Astro static, **Capacitor apps** |
|
|
108
|
-
| `ci-laravel.yml` | `.github/workflows/ci.yml` | Laravel + Inertia + Vite fullstack (with route/type codegen) | Same resolution for **both** PHP and Node.
|
|
109
|
-
| `ci-node-heavy.yml`, `ci-python-heavy.yml`, `ci-laravel-heavy.yml` | `.github/workflows/ci-heavy.yml` | The heavy lane beside the matching `ci-<stack>.yml` (above) | `schedule` + `workflow_dispatch` + `workflow_call`, never a push.
|
|
110
|
-
| `ci-python.yml` | `.github/workflows/ci.yml` | Python: FastAPI/Flask services, CLIs, libraries |
|
|
107
|
+
| `ci-call.yml` | `.github/workflows/ci.yml` | The generic caller: a hybrid repo, or a stack with no `ci-<stack>.yml` of its own (#721) | **A caller, not a copy:** triggers, concurrency and one `uses:` of the handbook's reusable `.github/workflows/ci-light.yml` — the dedupe gate, the secret scan, a `quick` and a `full` job, job-class `runs-on`. `colab template ci-call` writes this repo's trunk refs and pins the call to the release it stamps. Your commands go in `with:` (`toolchain`, `install`, `quick`, `full`); your own jobs sit beside the call. A copied gate is reported as drift. |
|
|
108
|
+
| `ci-node.yml` | `.github/workflows/ci.yml` | Pure Node repos: Vite SPA, node libs, Astro static, **Capacitor apps** | A **caller** of `ci-light.yml` (#724), its `with:` filled in for Node: typecheck/lint in `quick`, `npm test` and the build in `full`, each only if `package.json` declares it. The call resolves Node from `project.yml` → `.nvmrc`/`engines` → **fails**. Never a default. Opt-in `Migration round-trip` job beside the call — `--roundtrip` writes it live, see *Migration round-trip* below. |
|
|
109
|
+
| `ci-laravel.yml` | `.github/workflows/ci.yml` | Laravel + Inertia + Vite fullstack (with route/type codegen) | A **caller** of `ci-light.yml` (#724). Same resolution for **both** PHP and Node. Its `full` script carries the test tier (`RUN_TESTS`), the sqlite bootstrap + explicit wayfinder step and the Vite build; beside the call, a `migrations` job that round-trips the schema (migrate → rollback → seed → migrate, schema compared) on the test engine **and** the deploy engine (a MariaDB/MySQL service container at production's version). Its data-dependent checks need `ROUNDTRIP_SEEDER` — see *Migration round-trip* below. |
|
|
110
|
+
| `ci-node-heavy.yml`, `ci-python-heavy.yml`, `ci-laravel-heavy.yml` | `.github/workflows/ci-heavy.yml` | The heavy lane beside the matching `ci-<stack>.yml` (above) | `schedule` + `workflow_dispatch` + `workflow_call`, never a push. **Still a copy** (#724 kept it one: it runs nightly and on candidates, never per merge, so it is not what drifted, and its plan gate is per-repo). Its toolchain resolution follows the same precedence as the reusable light lane's, and the `secrets` job's gitleaks install and `GITLEAKS_VERSION` follow its `gitleaks` job — keep them in step. `TRUNK` is an edit point. |
|
|
111
|
+
| `ci-python.yml` | `.github/workflows/ci.yml` | Python: FastAPI/Flask services, CLIs, libraries | A **caller** of `ci-light.yml` (#724): byte-compile, ruff and mypy in `quick`, pytest in `full`, each only if installed. The call resolves Python from `project.yml` → `.python-version`/`requires-python` → **fails**. `requirements.txt` does not count. **Hybrid** Python+Node repo: `toolchain: python,node` in the same call — see the template header. Opt-in `Migration round-trip` job, as in `ci-node.yml`. |
|
|
111
112
|
| `release-tag.yml` | `.github/workflows/release.yml` | Any repo cutting `v*.*.*` releases | Triggers on tag push. Publishes a grouped GitHub Release — a `-rc.N` tag as a pre-release, every summary since the previous *final* tag. No toolchain, no deploy; its header shows the `!v*.*.*-*` exclusion a deploy trigger needs. |
|
|
112
|
-
| `release-auto.yml` | `.github/workflows/release-auto.yml` | A repo whose release tags land on `main` (`trunk: main`, `deploy: tag` or `none`) and whose §6 release route cuts candidates | Runs `colab release cut --auto` after CI goes green on main — at the sha that CI run tested (`--sha`, #622), even once main has moved on — and `colab release finalize --auto` daily — plus an hourly run that re-tries only a refused cut, once the fetched CLI has moved within `RETRY_WINDOW_MINUTES` or a run at main's head was cancelled (#547)
|
|
113
|
+
| `release-auto.yml` | `.github/workflows/release-auto.yml` | A repo whose release tags land on `main` (`trunk: main`, `deploy: tag` or `none`) and whose §6 release route cuts candidates | Runs `colab release cut --auto` after CI goes green on main — at the sha that CI run tested (`--sha`, #622), even once main has moved on — and `colab release finalize --auto` daily — plus an hourly run that re-tries only a refused cut, once the fetched CLI has moved within `RETRY_WINDOW_MINUTES` or a run at main's head was cancelled (#547). A first job, `decide`, skips the heavy job on a run with nothing to do: a red CI run, a CI run at a sha that already carries its tag, or an hourly run with nothing to retry (#735). It uses a handbook ref (`HANDBOOK_REF` — the `stable` channel by default, `next` for the fast channel, or an exact tag to freeze; #445) — the handbook's own copy runs its checkout's CLI instead, since it ships the CLI it releases with (#428). **Publishes the Release in the same run** — a tag pushed with `GITHUB_TOKEN` triggers no other workflow, so `release-tag.yml` would never fire for it. A refusal is a warning, not a red run. Reads and creates tags, and fast-forwards the release channels `next` / `stable` (branches naming the newest candidate / final, #445); never pushes a commit. The audit recognises any workflow running `release cut/finalize --auto` and warns when the route leaves candidates off, when it tags without publishing while a tag-push workflow waits, or when it commits. |
|
|
113
114
|
| `forgejo-release-auto.yml` | `.forgejo/workflows/release-auto.yml` | A repo hosted on **Forgejo** (or Gitea) whose §6 release route cuts candidates, with the forge named in the machine config's `forges` (#678) | The Forgejo dialect of `release-auto.yml` (#681). It has no `workflow_run`: the job you append to your CI (in its header) dispatches it when CI ends green, with `source=ci-completed` and the sha it tested. It waits for CI at that sha (`colab ci-wait`), then runs `colab release cut --auto --sha`, which tags the candidate and publishes its pre-release through the forge's API. No `permissions:` blocks, full-URL `uses:`, the runner label from the `RELEASE_RUNNER` variable, verdicts printed to the log (Forgejo drops the step summary), no `jq`. A refusal stays green. No verdict is a red run. **No finalize step**: on a forge a final is a human's `release finalize` under the human bar, which also publishes the final's release, so no tag-push workflow is needed. Keep its `name:` equal to the file's base name, because the CLI drops its own statuses by that name. |
|
|
114
115
|
| `dist-refs.yml` | `.github/workflows/dist-refs.yml` | A **private** repo shipping a **compiled** tool, installed as `npx github:<org>/<repo>#vX.Y.Z` ([CONVENTIONS §6, *Distribution*](../CONVENTIONS.md#distribution--one-install-surface-npx-442)) | `workflow_call`, called from the same run that cut the release tag (a tag pushed with `GITHUB_TOKEN` triggers nothing else). Takes one build artifact per `<os>-<arch>` and pushes each as an orphan commit at `refs/tags/dist/vX.Y.Z/<os>-<arch>` with a `SHA256SUMS`. Refuses a public or unreadable repository (a public compiled tool ships npm platform packages instead), a version that is not an existing tag, and a missing platform — before pushing any. Never moves a dist ref that exists. |
|
|
115
116
|
| `npx-launcher.mjs` | anywhere in-repo (e.g. `bin/launch.mjs`), named by the root `package.json`'s `bin` | Pairs with `dist-refs.yml` | Node ≥ 18, zero dependencies, needs `git`. Reads the `#vX.Y.Z` npx installed, fetches that one dist ref with the same URL and credentials npx cloned with, verifies `SHA256SUMS`, installs to a stable per-user path (`$XDG_DATA_HOME`/`%LOCALAPPDATA%`), and execs it; `--print-path` prints that path. A **channel** committish (`#stable`, `#next`, #465) is resolved to the release tag on the commit npx installed, then installed as that version; any other branch is refused. Also the library `npx-service.mjs` imports. `*.mjs`, so `colab template npx-launcher.mjs --dest <path>` copies it stamped, `--dest` required. One edit point: `BIN` (defaults to the package name without its scope). |
|
|
@@ -183,26 +184,58 @@ run cannot: secrets only trunk gets, `github.ref`-conditional steps, unpinned ru
|
|
|
183
184
|
The guard above drifted copy by copy: measured across adopters (2026-11-09 → 11-11), missing in six
|
|
184
185
|
repositories and present but never skipping in three, and #717's fix reached a copy only through a manual
|
|
185
186
|
sync. `.github/workflows/ci-light.yml` carries the same guard, the same secret scan and the descriptor check
|
|
186
|
-
once, for every caller; `ci-
|
|
187
|
+
once, for every caller; `ci-node.yml`, `ci-python.yml` and `ci-laravel.yml` are its callers since #724, and
|
|
188
|
+
`ci-call.yml` is the generic one. What changes for you:
|
|
187
189
|
|
|
188
190
|
- **Only the caller is yours**: the triggers and `concurrency` (a called workflow cannot own either), the
|
|
189
191
|
`with:` block, and your own jobs beside the call. A job behind the gate reads `needs: ci` +
|
|
190
|
-
`if: ${{ !cancelled() && needs.ci.outputs.tested != 'true' }}
|
|
191
|
-
in `trunk-only-jobs` (#717).
|
|
192
|
-
- **Pinned to a release tag, never `main`.** `colab template ci
|
|
193
|
-
with; `colab update` moves a pristine copy's stamp and pin together
|
|
192
|
+
`if: ${{ !cancelled() && needs.ci.result == 'success' && needs.ci.outputs.tested != 'true' }}` (the
|
|
193
|
+
result term keeps it off a red call); a trunk-only job outside it is named in `trunk-only-jobs` (#717).
|
|
194
|
+
- **Pinned to a release tag, never `main`.** `colab template ci-<stack>` writes the version it stamps the
|
|
195
|
+
copy with; `colab update` moves a pristine copy's stamp and pin together — including a pristine full copy
|
|
196
|
+
from before #724, which it moves onto the caller. **Until a final release carries `ci-light.yml`** (the
|
|
197
|
+
stamp is always the latest final, never a candidate, #334), `colab template ci-<stack>` and `colab update`
|
|
198
|
+
write that release's *own* template — a full copy that runs today — never a caller pinned at a release
|
|
199
|
+
that cannot run it (#724).
|
|
194
200
|
- **The quick/full split is two jobs**: `quick` (descriptor check, lint, types, unit — the `quick` class)
|
|
195
201
|
and `full` (the light suite, the build — the `full` class); both run on every push the gate does not skip,
|
|
196
202
|
and both take the `trunk` class on a trunk ref under `runs-on: classes`.
|
|
197
|
-
-
|
|
198
|
-
|
|
199
|
-
|
|
203
|
+
- **On a non-trunk ref, full starts only after quick passed** (#734). Those are the refs `concurrency`
|
|
204
|
+
cancels, and a run cancelled by the next push used to have every lane running already: late cancels
|
|
205
|
+
were 8.5% of a self-hosted fleet's runner-minutes over 14 days. A trunk run is unchanged — never
|
|
206
|
+
cancelled, never delayed, full beside quick. `needs:` cannot be conditional, so the call holds the full
|
|
207
|
+
command as two jobs of one name (`full` on trunk, `full-staged` elsewhere); exactly one runs, a required
|
|
208
|
+
check by name is met by it, and the gate does not count the skipped twin as a skip (#511).
|
|
209
|
+
A red quick on a branch therefore hides that push's full failures until quick is fixed — the price of
|
|
210
|
+
not paying for a full run whose verdict is already red.
|
|
211
|
+
- **Not calling it yet?** A hand-written CI with heavy jobs (full tests, browser/e2e, desktop builds) should
|
|
212
|
+
stage them the same way: on a non-trunk ref, `needs:` the quick job and require
|
|
213
|
+
`needs.<quick>.result == 'success'`; on a trunk ref, keep them beside it. The pair, as the call writes it:
|
|
214
|
+
```yaml
|
|
215
|
+
e2e: # trunk twin — unchanged
|
|
216
|
+
needs: dedupe
|
|
217
|
+
if: ${{ !cancelled() && needs.dedupe.outputs.tested != 'true' && contains(fromJSON('["main","dev"]'), github.ref_name) }}
|
|
218
|
+
e2e-staged: # every other ref — the ones concurrency cancels
|
|
219
|
+
name: <the same name as e2e>
|
|
220
|
+
needs: [dedupe, quick]
|
|
221
|
+
if: ${{ !cancelled() && needs.dedupe.outputs.tested != 'true' && needs.quick.result == 'success' && !contains(fromJSON('["main","dev"]'), github.ref_name) }}
|
|
222
|
+
```
|
|
223
|
+
Give both twins one `name:` and identical steps. If your copy carries the dedupe guard, its #511 skip
|
|
224
|
+
rule must also pass over a skipped job whose name a successful job of the same run carries (the call's
|
|
225
|
+
guard does — copy that `jq`), or no branch run can be cited at the landing again.
|
|
226
|
+
- **Mid-session backup pushes start no run at all** when they go to `refs/backup/<branch>` instead of the
|
|
227
|
+
branch (CONVENTIONS.md §7, *One verdict per tree*, rule 5).
|
|
228
|
+
- **The package caches moved too**: npm, pip and Composer, each on only on a GitHub-hosted runner and with
|
|
229
|
+
its lockfile present (#571), now in the call. Laravel's PHP extensions are the `php-extensions` input.
|
|
230
|
+
- A workflow still carrying its own copy of the gate is reported as drift — a suggestion until a handbook
|
|
231
|
+
release tag carries `ci-light.yml`, a warning from then on.
|
|
200
232
|
|
|
201
233
|
### Migration round-trip — have it from the first copy
|
|
202
234
|
|
|
203
235
|
`migration-grant: reviewer` grants only where a `Migration round-trip…` job passed at the
|
|
204
236
|
shipped head (condition R, [CONVENTIONS §5](../CONVENTIONS.md#migration-exemption--a-narrow-door-through-no-new-migrations-opened-by-a-role-98-402)).
|
|
205
|
-
`ci-laravel.yml` always carries it
|
|
237
|
+
`ci-laravel.yml` always carries it, as a job beside the call (`needs: ci`, behind the gate). `ci-node.yml`
|
|
238
|
+
and `ci-python.yml` carry it as an opt-in
|
|
206
239
|
block, and **the time to opt in is the copy** (#625):
|
|
207
240
|
|
|
208
241
|
```sh
|
|
@@ -214,7 +247,7 @@ colab template ci-python --dest .github/workflows/ci.yml --roundtrip --roundtrip
|
|
|
214
247
|
that can rewrite the job grading it never passes R — so that one branch, and its migration,
|
|
215
248
|
ships on a human grant. In the commit that creates the workflows, there is no such branch.
|
|
216
249
|
- **No migrations yet?** Leave out `--roundtrip-apply`. The job is written but **skipped**
|
|
217
|
-
until `ROUNDTRIP_APPLY` (
|
|
250
|
+
until `ROUNDTRIP_APPLY` (the `roundtrip-config` job's `env`, beside the call — a job-level `if:` cannot read `env`, so that small job hands it on) is set: a skipped leg never passes
|
|
218
251
|
R, so migrations ship on a human grant, and CI stays green — a fresh repo is not held red.
|
|
219
252
|
The build job prints a warning saying so. The cost while skipped: trunk does not reuse a
|
|
220
253
|
branch's identical-tree run (#511). A green no-op job would pass R without testing
|
package/templates/ci-call.yml
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
# CI (light lane) — CALLER of the handbook's reusable workflow (#721). Copy to .github/workflows/ci.yml
|
|
2
2
|
# with `colab template ci-call --dest .github/workflows/ci.yml`: it writes this repo's trunk refs and pins the call to the handbook
|
|
3
|
-
# release it stamps the copy with.
|
|
4
|
-
#
|
|
3
|
+
# release it stamps the copy with. Like templates/ci-<stack>.yml (callers too since #724, each with one
|
|
4
|
+
# stack's `with:` filled in — this one is the generic caller, for a hybrid), nothing below the `uses:` line is
|
|
5
|
+
# yours to maintain — the dedupe gate, the secret scan, the quick/full split (full staged behind quick on
|
|
6
|
+
# a non-trunk ref, #734) and the job-class
|
|
5
7
|
# `runs-on` live once, in .github/workflows/ci-light.yml of the handbook, and a release moves them.
|
|
6
8
|
#
|
|
7
9
|
# EDIT POINTS are marked `# EDIT:` — the `with:` block is the only real one.
|
|
@@ -69,5 +71,5 @@ jobs:
|
|
|
69
71
|
|
|
70
72
|
# Your own jobs go here, beside the call. Behind the gate (they skip when the tree already passed):
|
|
71
73
|
# needs: ci
|
|
72
|
-
# if: ${{ !cancelled() && needs.ci.outputs.tested != 'true' }}
|
|
74
|
+
# if: ${{ !cancelled() && needs.ci.result == 'success' && needs.ci.outputs.tested != 'true' }}
|
|
73
75
|
# Trunk-only and ungated: no `if:` on the guard, and list the job's name in `trunk-only-jobs` above.
|