@avi2dg/checks 0.39.0 → 0.40.0

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 Every release of `@avi2dg/checks`, newest first, written by the release from its conventional commits.
 
+## 0.40.0
+
+Released 2026-10-11.
+
+### Features
+
+- **delivery:** fold title lint into the ci job and trim docs-only runs [#146](https://github.com/avi2d/checks/pull/146)
+
 ## 0.39.0
 
 Released 2026-10-11.

package/README.md

@@ -117,7 +117,33 @@ To consume the kit from a repository:
          - run: bun run test
    ```
 
-Add a pull request title lint step in another workflow using `./node_modules/.bin/commitlint`.
+Lint the pull request title in the same job with one step:
+
+   ```yaml
+         - id: title
+           name: lint the title
+           env:
+             PR_TITLE: ${{ github.event.pull_request.title }}
+             GH_TOKEN: ${{ github.token }}
+           run: bunx checks-commit-title
+   ```
+
+A repository whose branch protection requires `commitlint` keeps that required status name while `commitlint.yml` goes away.
+The same job reports the title step's outcome under that name on every run, which needs `statuses: write`:
+
+   ```yaml
+         - name: report the title as commitlint
+           if: always()
+           env:
+             GH_TOKEN: ${{ github.token }}
+             HEAD_SHA: ${{ github.event.pull_request.head.sha }}
+             OUTCOME: ${{ steps.title.outcome }}
+           run: |
+             state=failure
+             if [ "$OUTCOME" = success ]; then state=success; fi
+             gh api "repos/$GITHUB_REPOSITORY/statuses/${HEAD_SHA:-$GITHUB_SHA}" -f state="$state" -f context=commitlint -f target_url="$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID" --silent
+   ```
+
 A private repository sets `runs-on: ${{ vars.CI_RUNS_ON || 'ubuntu-latest' }}` on each job, as [checks-ci-wiring](docs/gates/checks-ci-wiring.md#runners) requires.
 `checks-effect-scope` writes the Effect paths of `oxlint.config.ts` and the kit's severities into `tsconfig.json`, as [The Effect rules](docs/configs/effect-rules.md#language-service) says.
 `bun run lint` then ends with `checks-lint: <count> gate(s) pass`.
@@ -166,9 +192,11 @@ These bins run on their own:
 - [`checks-release-tag`](docs/gates/checks-release-tag.md) tags a landed release commit with its version and dispatches the release workflow on the tag.
 - [`checks-vendor`](docs/gates/checks-vendor.md) pins each library its `prepare` arguments name to a shared read-only clone and links it under `repos/`.
 - [`checks-browser`](docs/gates/checks-browser.md) opens a product's built pages in Chrome and fails on the layout, keyboard, motion, accessibility, nesting and asset checks its `browser-checks.json` declares.
+- [`checks-commit-title`](docs/gates/checks-commit-title.md) lints the pull request title in one step of the `ci` job.
+- [`checks-docs-only`](docs/gates/checks-docs-only.md) tells whether a change touches only top-level Markdown and Markdown under `docs/`, so a docs-only change skips the full run.
 
 `checks-lint` has [its own page](docs/gates/checks-lint.md), which says which range it resolves.
-oxlint and commitlint run through their own tools, as the pages under Related topics say.
+oxlint runs through its own tool, as the pages under Related topics say.
 
 ## Upgrade
 

package/docs/configs/commit-messages.md

@@ -14,20 +14,26 @@ It arrives with the kit, since `@commitlint/cli` and `@commitlint/config-convent
 ## Workflow
 
 The lint runs in CI on pull requests, because `jj` never fires a git hook.
-Each repository owns `.github/workflows/commitlint.yml` and runs the installed `commitlint` binary in a pull request step.
+Each repository lints the title in one step of its `ci` job with `bunx checks-commit-title`.
 The workflow lints with the installed kit's `commitlint.config.js`, so every repository holds titles to the same rules.
+The `ci` job reports the title step's outcome as a `commitlint` status on every run, so a required `commitlint` status stays while `commitlint.yml` goes away.
+That post needs the workflow's `statuses: write` permission.
+The title lint runs before the docs-only filter, so a change to top-level Markdown and `docs/` Markdown alone still lints its title.
 
 ## What it lints
 
 It lints the pull request title and nothing else.
 The title is the enforced subject because a squash merge uses it as the main commit subject, and per-commit messages are not linted.
-GitHub appends ` (#N)` to the squashed subject, so the workflow lints the title with that suffix attached, and the header length limit applies to the landed subject, not the bare title.
-The workflow moves git's comment character off `#`, so a title starting with `#` is linted like any other.
-The workflow also triggers on `workflow_dispatch`, since GitHub holds the `pull_request` runs of a release pull request the workflow token opens until a maintainer approves them, as [checks-release-pr](../gates/checks-release-pr.md) says.
-A dispatched run carries no pull request, so the workflow reads the title of the one open pull request its branch heads, and fails when there is none.
+GitHub appends the pull request number to the squashed subject, so the bin lints the title with ` (#0000)` attached.
+The header length limit applies to the landed subject, not the bare title.
+The bin moves the git comment character off `#`, so a title starting with `#` is linted like any other.
+The `ci` job also triggers on `workflow_dispatch`, as [checks-release-pr](../gates/checks-release-pr.md) says.
+GitHub holds the `pull_request` runs of a release pull request the workflow token opens until a maintainer approves them.
+A dispatched run carries no pull request, so the bin reads the title of the one open pull request its branch heads.
+It fails when there is none.
 That lookup needs the workflow's `pull-requests: read` permission.
-It reports a dispatched run's result on the head commit as a `commitlint` status, since GitHub keeps a dispatched run's check off the pull request.
-The kit's own `.github/workflows/commitlint.yml` shows the step.
+The `commitlint` status covers a dispatched run too, since GitHub keeps a dispatched run's check off the pull request.
+The kit's own `.github/workflows/ci.yml` shows the step.
 
 It never sees a commit's author or committer fields, nor the `Co-authored-by` trailer GitHub writes from a foreign author when it squashes, so it cannot enforce who a commit belongs to.
 [checks-commit-identity](../gates/checks-commit-identity.md) is that enforcement.

package/docs/gates/checks-ci-wiring.md

@@ -8,7 +8,8 @@ audience: consumers
 
 ## What it checks
 
-The kit requires `./node_modules/.bin/commitlint` on every pull request.
+The kit requires `bunx checks-commit-title` on every pull request.
+A step that calls `bun src/delivery/commit-title.ts` or `./node_modules/.bin/commitlint` directly still satisfies the check.
 It requires `bun run lint`, `bun run build`, `bun run typecheck` and `bun run test` for each of those scripts that `package.json` defines.
 A `build` script also requires `git diff --exit-code`.
 The target branch is the pull request base in CI, else the branch `refs/remotes/origin/HEAD` names, else the default branch of the repository in GitHub's event, else `main`.

package/docs/gates/checks-commit-title.md

@@ -0,0 +1,57 @@
+---
+kind: reference
+audience: consumers
+---
+# checks-commit-title
+
+`checks-commit-title` lints the pull request title against the shared commitlint config in one step of the `ci` job.
+
+## What it checks
+
+It lints the pull request title and nothing else.
+The title comes from `PR_TITLE` when the event carries one.
+A dispatched run carries no pull request, so the bin reads the title of the one open pull request its branch heads.
+It fails when there is none.
+A run with no title to lint passes and says so.
+The bin lints the title with ` (#0000)` attached, since GitHub appends the pull request number to the squashed subject.
+It moves the git comment character off `#`, so a title starting with `#` is linted like any other.
+
+## What it reads
+
+It reads `PR_TITLE` and `GITHUB_EVENT_NAME` from the environment.
+A dispatched run also reads `GITHUB_REPOSITORY`, `GITHUB_REPOSITORY_OWNER` and `GITHUB_REF_NAME`, and calls `gh api` with `GH_TOKEN` for the open pull request.
+It lints with the installed kit's commitlint config through the installed commitlint cli, as [The commit message lint](../configs/commit-messages.md) says.
+
+## Arguments
+
+The bin takes no arguments.
+
+## Exit codes
+
+| Code | Result |
+| --- | --- |
+| 0 | The title lints clean, or there is no title to lint. |
+| 1 | The title breaks the rules, or no one open pull request heads the branch. |
+| 2 | The kit config or binary cannot be resolved, or a dispatched run misses its environment. |
+
+## Sample output
+
+```
+⧗   --- input ---
+# feat(lint): add x (#0000)
+✖   subject may not be empty [subject-empty]
+✖   type may not be empty [type-empty]
+
+✖   found 2 problems, 0 warnings
+ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
+```
+
+## When it runs
+
+The `ci` job runs it on `pull_request` and `workflow_dispatch`, as [checks-ci-wiring](checks-ci-wiring.md) requires.
+The job then posts its outcome as a `commitlint` status, as [The commit message lint](../configs/commit-messages.md) says.
+
+## Related topics
+
+- [The commit message lint](../configs/commit-messages.md)
+- [checks-ci-wiring](checks-ci-wiring.md)

package/docs/gates/checks-docs-only.md

@@ -0,0 +1,50 @@
+---
+kind: reference
+audience: consumers
+---
+# checks-docs-only
+
+`checks-docs-only` tells whether a change touches only top-level Markdown and Markdown under `docs/`, so a docs-only change skips the full `ci` run.
+
+## What it checks
+
+A change is docs-only when every file it touches is a `.md` file at the top level or under `docs/`, and it touches at least one file.
+Markdown anywhere else, such as a test fixture under `tests/` or a template under `dist/`, keeps the full run.
+A rename counts both sides.
+An empty change and a change with no range keep the full run.
+
+## What it reads
+
+It reads the base and head refs from its arguments.
+It compares their merge base with the head through `git merge-base` and `git diff`.
+
+## Arguments
+
+```sh
+checks-docs-only <base-ref> <head-ref>
+```
+
+With no arguments, the bin reports `docs-only=false`.
+
+## Exit codes
+
+| Code | Result |
+| --- | --- |
+| 0 | The bin classified the change, and the verdict is on stdout. |
+| 2 | The range cannot be decoded. |
+
+## Sample output
+
+```
+docs-only=true
+```
+
+## When it runs
+
+The `ci` job has a filter step that appends the verdict to `GITHUB_OUTPUT`, and the typecheck and test steps skip when the verdict reads `true`.
+The build, its `git diff --exit-code` and `bun run lint` still run, so `checks-docs` and the generated blocks hold on a docs-only change.
+The job itself always runs and reports, so every required check stays green on a docs-only change.
+
+## Related topics
+
+- [checks-ci-wiring](checks-ci-wiring.md)

package/docs/gates/checks-release-pr.md

@@ -47,7 +47,7 @@ The repository needs **Allow GitHub Actions to create and approve pull requests*
 checks-release-pr <workflow>...
 ```
 
-Each argument names a workflow file under `.github/workflows/` whose jobs report the checks the default branch requires, such as `ci.yml` and `commitlint.yml`.
+Each argument names a workflow file under `.github/workflows/` whose jobs report the checks the default branch requires, such as `ci.yml`.
 Each named workflow triggers on `workflow_dispatch`.
 Name no workflow that runs something else on dispatch, such as a mutation baseline.
 
@@ -63,7 +63,7 @@ Name no workflow that runs something else on dispatch, such as a mutation baseli
 A run that opens the pull request prints the build's own output, then one line:
 
 ```
-release-pr: opened https://github.com/acme/widget/pull/12 to release 0.4.0, and dispatched ci.yml, commitlint.yml on release/main
+release-pr: opened https://github.com/acme/widget/pull/12 to release 0.4.0, and dispatched ci.yml on release/main
 ```
 
 A run on the same `HEAD` the next day prints one line:
@@ -115,7 +115,7 @@ jobs:
       - name: open or refresh the release pull request
         env:
           GH_TOKEN: ${{ github.token }}
-        run: ./node_modules/.bin/checks-release-pr ci.yml commitlint.yml
+        run: ./node_modules/.bin/checks-release-pr ci.yml
   tag:
     if: "github.event_name == 'push' && startsWith(github.event.head_commit.message, 'chore: release ')"
     runs-on: ubuntu-latest
@@ -150,8 +150,7 @@ Nothing requires them, and approving them runs the same checks again.
 
 The daily release needs the repository's other workflows to accept the dispatch:
 
-- `.github/workflows/ci.yml` and `.github/workflows/commitlint.yml` trigger on `workflow_dispatch`, grant `statuses: write`, and end each required job with the step below.
-  `commitlint.yml` also grants `pull-requests: read`, which the title lookup needs.
+- `.github/workflows/ci.yml` triggers on `workflow_dispatch`, grants `statuses: write` and `pull-requests: read`, and ends each required job with the step below.
 - The title lint reads the title of the one open pull request its branch heads when the event carries none, as [Commit messages](../configs/commit-messages.md) says.
 - `.github/workflows/release.yml` triggers on `workflow_dispatch` and refuses a ref that is not a tag, as [checks-release-notes](checks-release-notes.md) shows.
 - **Allow GitHub Actions to create and approve pull requests** is on, which the call after the step sets.

package/docs/gates/checks-release-tag.md

@@ -8,7 +8,7 @@ audience: consumers
 
 ## What it checks
 
-It reads the subject of `HEAD`, and does nothing unless the subject is `chore: release <version>`, with or without the ` (#N)` a squash merge adds.
+It reads the subject of `HEAD`, and does nothing unless the subject is `chore: release <version>`, with or without the pull request number a squash merge appends.
 It refuses a release commit whose `package.json` holds another version.
 It tags `HEAD` as `v<version>` and pushes the tag to `origin`.
 A tag the workflow token pushes starts no `push` workflow, so it then dispatches the workflow its argument names on the tag.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avi2dg/checks",
-  "version": "0.39.0",
+  "version": "0.40.0",
   "description": "Deterministic checks shared across a set of TypeScript repositories",
   "license": "MIT",
   "repository": {
@@ -40,6 +40,8 @@
     "src/testing/test-report.ts",
     "src/testing/flake.ts",
     "src/delivery/commit-identity.ts",
+    "src/delivery/commit-title.ts",
+    "src/delivery/docs-only.ts",
     "src/testing/mutation.ts",
     "src/testing/mutation-scope.js",
     "src/testing/mutation-guard-plugin.js",
@@ -132,6 +134,8 @@
     "checks-test": "src/testing/test.ts",
     "checks-flake": "src/testing/flake.ts",
     "checks-commit-identity": "src/delivery/commit-identity.ts",
+    "checks-commit-title": "src/delivery/commit-title.ts",
+    "checks-docs-only": "src/delivery/docs-only.ts",
     "checks-mutation": "src/testing/mutation.ts",
     "checks-mutation-compare": "src/testing/mutation-compare.ts",
     "checks-mutation-baseline": "src/testing/mutation-baseline.ts",

package/src/delivery/ci-wiring.ts

@@ -11,6 +11,7 @@ export type { Command };
 export type Gate = {
   readonly command: string;
   readonly words: Command;
+  readonly alternatives: readonly Command[];
 };
 
 export type Declaration = {
@@ -63,7 +64,10 @@ export class WiringError extends Schema.TaggedError<WiringError>()("WiringError"
 const WORKFLOWS = ".github/workflows";
 const SCRIPTED = ["lint", "build", "typecheck", "test"];
 const BUILT_TREE = "git diff --exit-code";
-const TITLE_LINT = "./node_modules/.bin/commitlint";
+const TITLE_LINT = "bunx checks-commit-title";
+// The gate holds until every consumer migrates, so the direct commitlint call still counts.
+// The kit calls its own file through bun, since bunx never resolves the working tree.
+const TITLE_CALLS = ["bun src/delivery/commit-title.ts", "./node_modules/.bin/commitlint"];
 const Manifest = Schema.Struct({ scripts: Schema.optionalKey(Schema.Record(Schema.String, Schema.String)) });
 // Without these a pull_request workflow never sees the commits a pull request pushes.
 const GATING_TYPES = ["opened", "synchronize"];
@@ -207,6 +211,7 @@ function gapsAmong(gates: readonly Gate[], steps: readonly RunStep[], lintGates:
     const entryPoint = entryPointCommand(gate.words, lintGates);
     const commands = [
       { command: gate.command, words: gate.words },
+      ...gate.alternatives.map((words) => ({ command: gate.command, words })),
       ...(entryPoint === undefined ? [] : [{ command: entryPoint.join(" "), words: entryPoint }]),
     ];
     const invoking = steps.flatMap(({ location, blocker, script }) => {
@@ -258,7 +263,11 @@ export function requiredCommands(scripts: readonly string[]): readonly string[]
 
 export function declarationFor(scripts: readonly string[], branch: string): Declaration {
   return {
-    gates: requiredCommands(scripts).map((command) => ({ command, words: command.split(" ") })),
+    gates: requiredCommands(scripts).map((command) => ({
+      command,
+      words: command.split(" "),
+      alternatives: command === TITLE_LINT ? TITLE_CALLS.map((call) => call.split(" ")) : [],
+    })),
     defaultBranch: branch,
     lintGates: KIT_GATES,
   };

package/src/delivery/commit-title.ts

@@ -0,0 +1,82 @@
+#!/usr/bin/env bun
+import { Config, Console, Effect, FileSystem, Path, Schema } from "effect";
+import { collect } from "../core/git.ts";
+import { runMain } from "../core/main.ts";
+
+const NAME = "commit-title";
+
+class TitleSetup extends Schema.TaggedError<TitleSetup>()("TitleSetup", {
+  message: Schema.String,
+}) {}
+
+const setup = (message: string): TitleSetup => new TitleSetup({ message });
+
+// The cli entry stays inside its own package, so this resolves from the install cache as well as node_modules.
+const cliOf = Effect.fn("cliOf")(function* () {
+  const entry = yield* Effect.try({
+    try: () => new URL("./cli.js", import.meta.resolve("@commitlint/cli")),
+    catch: () => setup("cannot resolve @commitlint/cli from the installed kit"),
+  });
+  return yield* (yield* Path.Path).fromFileUrl(entry);
+});
+
+// The config ships with the kit, so it sits two levels above this file wherever the kit is installed.
+const configOf = Effect.fn("configOf")(function* () {
+  const file = yield* Effect.try({
+    try: () => new URL("../../commitlint.config.js", import.meta.url),
+    catch: () => setup("cannot resolve commitlint.config.js from the installed kit"),
+  });
+  return yield* (yield* Path.Path).fromFileUrl(file);
+});
+
+const dispatchedTitle = Effect.fn("dispatchedTitle")(function* () {
+  const repository = yield* Config.String("GITHUB_REPOSITORY").pipe(Config.withDefault(""));
+  const owner = yield* Config.String("GITHUB_REPOSITORY_OWNER").pipe(Config.withDefault(""));
+  const ref = yield* Config.String("GITHUB_REF_NAME").pipe(Config.withDefault(""));
+  if (repository === "" || owner === "" || ref === "") {
+    return yield* setup("a dispatched run lints the open pull request its branch heads, so it needs GITHUB_REPOSITORY, GITHUB_REPOSITORY_OWNER and GITHUB_REF_NAME");
+  }
+  // A dispatched run carries no pull request, so the title comes from the one open pull request the branch heads.
+  const found = yield* collect("gh", [
+    "api",
+    `repos/${repository}/pulls?head=${owner}:${ref}&state=open`,
+    "--jq",
+    `if length == 1 then .[0].title else error("no one open pull request heads the branch") end`,
+  ]);
+  const title = found.stdout.trim();
+  if (found.exitCode !== 0 || title === "" || title === "null") {
+    const report = found.stderr.trim() === "" ? found.stdout.trim() : found.stderr.trim();
+    if (report !== "") yield* Console.error(report);
+    return undefined;
+  }
+  return title;
+});
+
+const lintTitle = Effect.fn("lintTitle")(function* (title: string) {
+  const system = yield* FileSystem.FileSystem;
+  const path = yield* Path.Path;
+  const file = path.join(yield* system.makeTempDirectoryScoped({ prefix: "checks-commit-title-" }), "pr-title");
+  yield* system.writeFileString(file, `${title} (#0000)`);
+  // A title opening with the git comment character lints as empty without this: commentChar moves off the hash.
+  const linted = yield* collect(process.execPath, [yield* cliOf(), "--config", yield* configOf(), "--edit", file], undefined, {
+    env: { GIT_CONFIG_COUNT: "1", GIT_CONFIG_KEY_0: "core.commentChar", GIT_CONFIG_VALUE_0: "\x01" },
+  });
+  if (linted.stdout.trim() !== "") yield* Console.log(linted.stdout.trim());
+  if (linted.stderr.trim() !== "") yield* Console.error(linted.stderr.trim());
+  return linted.exitCode === 0;
+});
+
+const check = Effect.scoped(Effect.gen(function* () {
+  const direct = yield* Config.String("PR_TITLE").pipe(Config.withDefault(""));
+  if (direct !== "") return yield* lintTitle(direct);
+  const event = yield* Config.String("GITHUB_EVENT_NAME").pipe(Config.withDefault(""));
+  if (event === "workflow_dispatch") {
+    const title = yield* dispatchedTitle();
+    if (title === undefined) return false;
+    return yield* lintTitle(title);
+  }
+  yield* Console.log(`${NAME}: no pull request title is available, so there is nothing to lint`);
+  return true;
+}));
+
+if (import.meta.main) runMain(NAME, check);

package/src/delivery/docs-only.ts

@@ -0,0 +1,38 @@
+#!/usr/bin/env bun
+import { Console, Effect } from "effect";
+import { changedPaths, git } from "../core/git.ts";
+import { runMain } from "../core/main.ts";
+
+const NAME = "docs-only";
+
+export function isDocsPath(path: string): boolean {
+  const lower = path.toLowerCase();
+  return lower.endsWith(".md") && (!lower.includes("/") || lower.startsWith("docs/"));
+}
+
+// The verdict goes to stdout as one line, so a step appends it to GITHUB_OUTPUT; the detail goes to stderr.
+const check = Effect.gen(function* () {
+  const [base, head] = process.argv.slice(2);
+  if (base === undefined || head === undefined) {
+    yield* Console.error(`${NAME}: no range is given, so the full run stays`);
+    yield* Console.log("docs-only=false");
+    return true;
+  }
+  const mergeBase = (yield* git(["merge-base", base, head])).trim();
+  const changes = yield* changedPaths(mergeBase, head, []);
+  const paths = changes.flatMap((change) => (change.kind === "renamed" ? [change.from, change.path] : [change.path]));
+  const full = paths.filter((path) => !isDocsPath(path));
+  if (paths.length === 0) {
+    yield* Console.error(`${NAME}: the range changes no file, so the full run stays`);
+    yield* Console.log("docs-only=false");
+  } else if (full.length === 0) {
+    yield* Console.error(`${NAME}: ${paths.length} changed file(s) are all top-level or docs/ Markdown, so the full run can skip`);
+    yield* Console.log("docs-only=true");
+  } else {
+    yield* Console.error(`${NAME}: ${full.length} changed file(s) need the full run`);
+    yield* Console.log("docs-only=false");
+  }
+  return true;
+});
+
+if (import.meta.main) runMain(NAME, check);