mirror of
https://github.com/garrytan/gstack.git
synced 2026-11-10 02:30:39 +01:00
Garry Tanandcapy-ai[bot]
e077053c3c
* Let pull requests that only change human-facing docs skip the test suites (GST-1951) Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com> * Quote the docs test list in the docs lane so shellcheck passes Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com> * Keep the Windows smoke check green on docs-only pull requests and update the workflow contract tests Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com> * Keep the merged test check when the base gained a reader of a changed doc, hold the land policy key until a release reads it, and register two more docs reader tests Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com> * Check links in untracked docs and docs with quoted or spaced names, and report an undecodable anchor instead of crashing Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com> * Point the flaky-exception anchor back at its section and test the link checker's exit codes Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com> --------- Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
58 lines
3.6 KiB
TypeScript
58 lines
3.6 KiB
TypeScript
/**
|
|
* R81 docs-only carry (lib/run-evidence.ts verifyRun, lib/ci-carry.ts findCarry; docs/pregate.md#docs-only): a pull
|
|
* request run whose docs-scope gate skipped every suite on a docs-only change carries as not owed, and only when this
|
|
* checkout's classifier agrees. The same run never stands as a tested tree. Fakes only; nothing reaches GitHub.
|
|
*/
|
|
import { expect, test } from 'bun:test';
|
|
import { findCarry } from '../lib/ci-carry';
|
|
import type { ApiJob, ApiRun, RunDeps, RunProfile, RunSource } from '../lib/run-evidence';
|
|
import { verifyRun } from '../lib/run-evidence';
|
|
|
|
const REPO = 'garrytan/gstack';
|
|
const HEAD = 'a'.repeat(40);
|
|
const TREE = 'b'.repeat(40);
|
|
const NOW = new Date('2026-11-08T12:00:00Z');
|
|
const SUITES = ['free-plan', 'typecheck'];
|
|
const PROFILE: RunProfile = { workflow: 'free-tests.yml', events: ['pull_request', 'workflow_dispatch'], jobs: [...SUITES, 'free-tests'], artifact: 'tested-tree', os: 'Linux', skippable: { jobs: SUITES, gate: 'docs-scope', scripts: ['lib/docs-only.ts'] } };
|
|
const RUN: ApiRun = { id: 7, run_attempt: 1, status: 'completed', conclusion: 'success', event: 'pull_request', head_sha: HEAD, path: '.github/workflows/free-tests.yml', created_at: '2026-11-08T11:00:00Z', updated_at: '2026-11-08T11:10:00Z', repository: { full_name: REPO }, head_repository: { full_name: REPO } } as ApiRun;
|
|
const job = (name: string, conclusion: string): ApiJob => ({ name, conclusion, completed_at: '2026-11-08T11:10:00Z' }) as ApiJob;
|
|
const JOBS = [job('docs-scope', 'success'), ...SUITES.map(n => job(n, 'skipped')), job('free-tests', 'success')];
|
|
let artifactReads = 0;
|
|
const deps: RunDeps = {
|
|
run: () => RUN,
|
|
runsForHead: (_wf, sha) => (sha === HEAD ? [RUN] : []),
|
|
jobs: () => JOBS,
|
|
artifact: () => { artifactReads++; throw new Error('no artifact'); },
|
|
commitTree: sha => (sha === HEAD ? TREE : null),
|
|
};
|
|
const source = (docsOnly?: (h: string) => boolean): RunSource => ({ repo: REPO, deps, profiles: { 'ci-reuse/free-tests': PROFILE }, now: NOW, unchanged: () => null, ...(docsOnly ? { docsOnly } : {}) });
|
|
const carry = (src: RunSource) => findCarry(src, { profiles: ['ci-reuse/free-tests'], head: HEAD, tree: TREE, wtree: () => TREE, inventory: () => ['test/a.test.ts'] });
|
|
|
|
test('a docs-only pull request run carries as not owed without reading a tested tree', () => {
|
|
artifactReads = 0;
|
|
const v = carry(source(h => h === HEAD));
|
|
expect(v.ok).toBe(true);
|
|
if (!v.ok) return;
|
|
expect(v.notOwed).toContain('docs-only change');
|
|
expect(v.tests).toBe('n/a');
|
|
expect(v.receipt).toMatch(/^ci-carry tree=bbbbbbbbbbbb not_owed=docs-only runs=7\/1 /);
|
|
expect(artifactReads).toBe(0);
|
|
});
|
|
|
|
test('the same skipped run does not carry when this checkout calls the change code (a reused run, or a moved base)', () => {
|
|
const v = carry(source(() => false));
|
|
expect(v.ok).toBe(false);
|
|
if (!v.ok) expect(v.detail).toContain('artifact_missing');
|
|
});
|
|
|
|
test('without a classifier (ci-tree-reuse find), a docs-only run is never a tested tree, so a push to main cannot reuse it', () => {
|
|
const v = verifyRun(deps, { repo: REPO, runRef: '7', profileName: 'ci-reuse/free-tests', profile: PROFILE, now: NOW, unchanged: () => null });
|
|
expect(v.ok ? 'ok' : v.reason).toBe('artifact_missing');
|
|
});
|
|
|
|
test('a run whose gate job failed never counts its skipped suites', () => {
|
|
const failed: RunDeps = { ...deps, jobs: () => [job('docs-scope', 'failure'), ...SUITES.map(n => job(n, 'skipped')), job('free-tests', 'success')] };
|
|
const v = verifyRun(failed, { repo: REPO, runRef: '7', profileName: 'ci-reuse/free-tests', profile: PROFILE, now: NOW, unchanged: () => null, docsOnly: () => true });
|
|
expect(v.ok ? 'ok' : v.reason).toBe('job_skipped');
|
|
});
|