IF Commons GitHub

workflows/definitions

The workflows of this repository, as the typed values the files under .github/workflows/ are made from (commons 0030-generated-workflows FR-001, FR-005, FR-006): the pins and the steps they share are written once, the workflow of each library of commons is made from its manifest, and the rest are written here as values. Nothing is read from a file but the manifests, and nothing is written.

workflows() gives every workflow, in the order of their files' names; the libraries are proved by one workflow, ci, whose plan reads which libraries a change affects and runs a matrix of those (the folder, the name and the verify command of a manifest, 0027-commons-libraries FR-012, and what else the library needs from LIBRARY_CI, the facts of CI that a manifest does not hold: a library without a record has verify on Linux and nothing else).

Source: commons/libraries/src/workflows/definitions.ts

4 of 10 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

PINconst
const PIN: { readonly checkout: "actions/checkout@v4"; readonly setupNode: "actions/setup-node@v4"; readonly cache: "actions/cache@v4"; readonly uploadArtifact: "actions/upload-artifact@v4"; readonly downloadArtifact: "actions/download-artifact@v4"; readonly uploadPages: "actions/upload-pages-artifact@v3"; readonly deployPages: "actions/deploy-pages@v4"; readonly bun: "./.github/actions/bun"; }

The versions the workflows pin (FR-005): each once.

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

NODE_VERSIONconstno test imports it
const NODE_VERSION: "26.13.1"

The Node that is the backup runtime (commons 0005-typescript-practice FR-018).

BUN_LINT_VERSIONconstno test imports it
const BUN_LINT_VERSION: "1.4.4-canary.20261115.1"

The canary of Bun that runs the linter until a release does (commons 0005-typescript-practice FR-028).

OtherSystemtypeno test imports it
type OtherSystem = "windows-latest" | "macos-latest";

The systems other than Linux that a library's CI may ask for: only a library with code of its own for one of them (paths, processes, sockets, scheduled jobs) names it.

LibraryCitypeno test imports it
type LibraryCi = { /** The command that runs the tests on Node 26, the backup runtime, in the same job as `verify`. */… (419 characters)
type LibraryCi = {
  /** The command that runs the tests on Node 26, the backup runtime, in the same job as `verify`. */
  readonly nodeTests?: string;
  /** A command that runs after `verify`, in the same job. */
  readonly after?: string;
  /** The systems besides Linux where `verify` and the tests on Node run too, because the library has code of its own for them. */
  readonly systems?: readonly OtherSystem[];
};

What a library's CI needs that its manifest does not say: Linux and verify are for every library, and these are the rest.

LIBRARY_CIconst
const LIBRARY_CI: Readonly<Record<string, LibraryCi>>

The facts of CI of the libraries that have more than verify on Linux, by the library's name; a library with no record has verify on Linux only.

Imported by 11 tests of the run (11 passed, 0 failed): the library's results

Celltypeno test imports it
type Cell = { readonly name: string; readonly folder: string; readonly verify: string; /** The command that runs… (589 characters)
type Cell = {
  readonly name: string;
  readonly folder: string;
  readonly verify: string;
  /** The command that runs the tests on Node 26, or the empty string. */
  readonly node: string;
  /** The command that runs after `verify`, or the empty string. */
  readonly after: string;
  /** Whether the packing is checked in this cell: the library changed its `exports` (or the packer changed), or the run is of everything. A push does not pack otherwise; the release does. */
  readonly pack: boolean;
  /** The runner, for a cell that is not on Linux. */
  readonly os?: OtherSystem;
};

A cell of the matrix of a job of ci: a library, and where it runs where it is not on Linux.

cellOffunctionno test imports it
function cellOf(l: { readonly name: string; readonly folder: string; readonly verify: string; }, os?: OtherSystem | undefined, pack?: boolean): Cell

The cell of a library on a system (ubuntu-latest, where it names none), from its manifest and its record of CI; pack says whether the packing is checked in it.

workflowsfunction
function workflows(): readonly Workflow[]

Every workflow, the libraries' made from their manifests, in the order of their files' names, under the build policy.

Imported by 14 tests of the run (14 passed, 0 failed): the library's results

ACTIONSconst
const ACTIONS: readonly CompositeAction[]

The composite actions of .github/actions/: the pinned Bun, which every workflow uses.

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.