@futurelastic/colab-handbook 1.21.0-rc.7 → 1.21.0-rc.8
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/package.json +1 -1
- package/templates/README.md +25 -0
- package/templates/ci-call.yml +2 -1
package/package.json
CHANGED
package/templates/README.md
CHANGED
|
@@ -200,6 +200,31 @@ once, for every caller; `ci-node.yml`, `ci-python.yml` and `ci-laravel.yml` are
|
|
|
200
200
|
- **The quick/full split is two jobs**: `quick` (descriptor check, lint, types, unit — the `quick` class)
|
|
201
201
|
and `full` (the light suite, the build — the `full` class); both run on every push the gate does not skip,
|
|
202
202
|
and both take the `trunk` class on a trunk ref under `runs-on: classes`.
|
|
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).
|
|
203
228
|
- **The package caches moved too**: npm, pip and Composer, each on only on a GitHub-hosted runner and with
|
|
204
229
|
its lockfile present (#571), now in the call. Laravel's PHP extensions are the `php-extensions` input.
|
|
205
230
|
- A workflow still carrying its own copy of the gate is reported as drift — a suggestion until a handbook
|
package/templates/ci-call.yml
CHANGED
|
@@ -2,7 +2,8 @@
|
|
|
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
3
|
# release it stamps the copy with. Like templates/ci-<stack>.yml (callers too since #724, each with one
|
|
4
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
|
|
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
|
|
6
7
|
# `runs-on` live once, in .github/workflows/ci-light.yml of the handbook, and a release moves them.
|
|
7
8
|
#
|
|
8
9
|
# EDIT POINTS are marked `# EDIT:` — the `with:` block is the only real one.
|