Skip to content

ci: skip the heavy jobs for documentation-only changes - #173

Merged
with-developer merged 2 commits into
mainfrom
ci/faster-jobs
Nov 19, 2026
Merged

with-developer merged 2 commits into
mainfrom
ci/faster-jobs

Conversation

@with-developer

@with-developer with-developer commented Nov 19, 2026 •

Copy link
Copy Markdown
Owner

What changes for a contributor, and how to revert

A pull request that changes only Markdown files and the pictures under docs/images/ skips the jobs that build and run the code (oldest Rust, browser build, build + test on three systems, XCFramework); the lint job still runs, as it checks the documents' figures and the copies of LICENSE and the notices. A push to main runs everything. To revert, revert this commit.

Purpose

The CI of a pull request took about 17 minutes, which is the XCFramework job. Most of the pull requests of the last two weeks changed only documents and benchmark tables.

Changes

A what changed job compares the pull request's files with its base and says whether anything is not a Markdown file or a picture of docs/images/; the four jobs above need it and are skipped when it says no.

What was tried and taken out

Measured on this pull request, cold and warm:

  • The XCFramework checks as three parallel jobs: 17.1 minutes before, 15.1 cold and 16.7 warm after. Alone, each check is slower than in the shared job (the iPhone app 912 s against 465 s, the examples 657 s against 398 s), because the later checks reuse the earlier ones' builds, so it cost almost twice the Mac minutes for no gain.
  • A cache for the Vulkan driver's packages: the Linux job took 1.8 minutes cold and 2.2 warm, the earlier 6.4 minutes were the mirror's slowness.

Testing

This pull request changes a workflow, so every job ran and passed. The skip itself is tested by the next documentation-only pull request, which should show what changed passing and the heavy jobs skipped; if it does not, that pull request is the place to fix it.

… side by side

The CI of a pull request took 17 minutes, all of it the XCFramework job, whose
library builds in 48 seconds from the cache and whose three checks (the
examples, the iPhone app, the Mac measurements) took the rest one after the
other; the Linux job spent 250 of its 390 seconds installing the Vulkan
driver's packages.

- A "what changed" job says whether a pull request changes more than Markdown
  files and the pictures of docs/. If not, the jobs that build and run the code
  are skipped (a push to main runs everything, and lint always runs, since it
  checks the documents' figures and the copies of LICENSE and the notices).
- The XCFramework checks are a matrix of three jobs, each building the
  XCFramework from the shared cache and running one check, so the job takes as
  long as the longest check. No check is removed or changed.
- The Vulkan driver's packages are cached between runs.

Claude-Session: https://claude.ai/code/session_019fJGoCTvP5e7n599q3ZQ42
Measured on this pull request, with cold and warm caches:
- Splitting the XCFramework checks into three jobs did not shorten the
  pull request's CI: 17.1 minutes before, 15.1 cold and 16.7 warm after.
  Alone, each check takes longer than it did in the shared job (the iPhone
  app 912 s against 465 s, the examples 657 s against 398 s), since the later
  checks reuse the builds of the earlier ones there, so the three jobs cost
  almost twice the Mac minutes for the same wall time.
- Caching the Vulkan driver's packages saved nothing visible: the Linux job
  took 1.8 minutes cold and 2.2 minutes warm; the 250 seconds of the first
  measurement were the mirror's, not the packages'.

Both are taken out again. What stays is the "what changed" job, which skips
the jobs that build and run the code for a pull request that changes only
Markdown files and the pictures of docs/, which is a gain of about 17 minutes
for such a pull request, as the next documentation change will show.

Claude-Session: https://claude.ai/code/session_019fJGoCTvP5e7n599q3ZQ42
@with-developer with-developer changed the title ci: skip the heavy jobs for documentation, run the XCFramework checks side by side ci: skip the heavy jobs for documentation-only changes Nov 19, 2026
@with-developer
with-developer merged commit 1c9c01d into main Nov 19, 2026
8 checks passed
@with-developer
with-developer deleted the ci/faster-jobs branch November 19, 2026 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant