Files
PaperClipAI/doc/runner-image-contract.md
T
Nicky LeachandClaude Fable 5.2 e824c5cc16 feat(ci): let the Runner image resolver wait for the publication of a master push (#21339)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - The Runner is the part that executes agent work. `master` publishes
it alone as the image `ghcr.io/paperclipai/paperclip-runner`, once for
each set of its inputs
> - The application image will copy that Runner instead of making its
own. `scripts/runner-image-resolve.mjs` tells a build whether the Runner
of its inputs is published
> - On a `master` push, the commit's own run of `runner-image.yml` is
often still publishing when the application build asks. The resolver
answers once, so that build is told `absent` for an image that exists
some minutes later
> - The resolver also cannot say that a tree is not safe to give a
published Runner to. A `Dockerfile` that does not check the Runner it
receives builds with any Runner
> - This pull request adds an opt-in wait for the commit's own
publication run, and an `unsupported` answer for a `Dockerfile` that
cannot check its Runner
> - The benefit is that the next pull request can let `docker.yml` copy
the published Runner without a blind timeout and without a label that is
not true

## Linked Issues or Issue Description

Refs #21204, #21229, #21230 (the Runner image), #21306 (the resolver),
#21307 (the report-only job), and #21331, #21332, #21333 (the
application image takes its Runner from `runner-artifacts`). No issue
exists for this change.

**Problem or motivation**

A `master` push starts `runner-image.yml` and `docker.yml` at the same
time. Publication takes about 30 minutes from the push, and several of
those minutes are runner queue time. An application build that asks the
resolver at once gets `absent` for every commit that changes the
Runner's inputs, and for commits that follow one closely. A fixed poll
of the tag has the opposite fault: when no image will ever come (the
lockfile is behind, or the run failed), every build waits the full
timeout.

**Proposed solution**

`resolve --wait` waits for a run, not for a time. It finds the runs of
`runner-image.yml` for the push of the commit to `master`, and it looks
up the image again when they end. No caller uses the flag in this pull
request, so no workflow changes behavior.

**Alternatives considered**

- Poll the tag until a timeout. Every build with no image to come waits
the full timeout.
- Call `runner-image.yml` from `docker.yml` as a reusable workflow.
Publication would then share the one concurrency slot of `docker.yml`.
- Wait until the run completes and only then look. The run goes on after
publication (it writes the build cache), so the wait would last longer
than needed. The command looks up the image while a run is in progress.
- Verify the attestation in the resolver. The workflow that uses the
answer does it, in a step of its own, in the next pull request.

**Roadmap alignment**

This is build infrastructure. It adds no product feature and does not
overlap an item in `ROADMAP.md`.

This pull request is built on #21333. Merge in this order:

1. #21331, #21332, #21333: the application image takes its Runner from
the `runner-artifacts` stage, checks the inputs digest a build names,
and stops early on a stale lockfile.
2. This pull request: the wait and the `unsupported` answer of the
resolver.
3. `runner/app-image-consume-docker`: `docker.yml` copies the published
Runner, behind a repository variable.

The same change for the preview cloud image build in `release.yml` is
deferred. It has no pull request yet.

## What Changed

- `scripts/runner-image-resolve.mjs`
- `resolve --dir <directory> --wait`. When the first answer is `absent`
or `incomplete`, the command lists the runs of `runner-image.yml` for
the commit (Actions API, `GITHUB_SHA`, `GITHUB_TOKEN`) and looks again
when they end.
- Only a run of the `push` event on `master` in this repository counts.
A pull-request, scheduled or manual run of the same commit is never
waited for. The request filters by event and branch, and the script
checks each run again.
- A run that fails, is cancelled or publishes nothing ends the wait when
it ends. With several runs for one commit, the command waits for all of
them.
- While a run is in progress, the command looks up the image every 30
seconds, so the wait ends at publication.
  - A run that is not listed yet is looked for during 2 minutes.
- The limit is 40 minutes from the push: `RUNNER_IMAGE_WAIT_MINUTES`,
the one constant. The push time is the creation time of the oldest run
of the commit, so a build that starts late waits less.
- Three failed API requests in a row end the wait. No token or no full
commit SHA means no wait.
- After every ending the command looks up the image one last time. No
ending is an error. Without an image the answer is `inline`, and the
command prints a notice with the reason.
- `inputs` reads the `Dockerfile` first. Without a line `ARG
PAPERCLIP_RUNNER_EXPECT_INPUTS_DIGEST` it runs no build, and `resolve`
answers `inline` with the reason `unsupported`.
- `resolve` reports `build_args`: the value of that argument for a
`published` answer.
- The wait and the list of runs take the clock, the sleep and `fetch` as
arguments, so the tests use no network and do not sleep.
- `server/src/__tests__/runner-image-resolve.test.ts`: every outcome of
the wait and the answer that follows it, the run filter, the limit
measured from the push, the API failures, and the command line.
- `doc/runner-image-contract.md`: a "Waiting for a publication" section,
`build_args`, and the `unsupported` answer.

## Verification

macOS (Node 26.12.0) and Linux (`node:24.22.3-bookworm`, linux/arm64,
with `jq` and `zstd` added), on this branch on top of #21333:

- `pnpm exec vitest run` on `runner-image-resolve`,
`docker-runner-workflows`, `runner-image-workflow`,
`docker-build-stamp`, `container-init-reaping`,
`cloud-image-bundled-plugins`, `docker-image-layer-reuse`,
`cloud-image-sentry`, `runner-lockfile-guards` and
`runner-image-identity` in `server/src/__tests__`, and
`server/scripts/prepare-runner-vendor.test.mjs`: 218 tests in 11 files
pass on Linux; on macOS 217 pass and 1 is skipped (it needs bash 4.4).
- `node --test .github/scripts/tests/*.test.mjs
scripts/merge-group-image.test.mjs scripts/reuse-canary-image.test.mjs
scripts/cloud-source-verification.test.mjs
scripts/standard-image-contract.test.mjs
scripts/preview-artifacts.test.mjs
scripts/__tests__/release-verify-workflow.test.mjs
scripts/__tests__/release-dry-run-notes.test.mjs`: 991 of 991 pass on
both.
- The changed test file typechecks with the options of
`server/src/__tests__/tsconfig.json`.

Read-only checks against the real services:

- The lookup, with no credential, answered `published` for the inputs
`d4df566f…af00` and `0e6662ad…d1ca`, with the index digests that
`master` published, and `absent` for a digest that does not exist.
- The real answer of the Actions API for the `runner-image.yml` runs of
four `master` commits went through the wait, with a clock that does not
sleep. Three completed runs ended it at once. A queued run ended it at
the limit of 40 minutes from its creation time. A commit with no run
ended it after the 2 minutes for a run that is not listed.
- Of the 60 newest runs of `runner-image.yml`, the filter accepted the
19 `push` runs on `master` and none of the 41 pull-request runs.
- `runner-image-resolve.mjs inputs` ran on a clean export of the tree of
the next pull request, with a `docker-container` builder. The answer was
`lock: current` and the inputs digest `c4f9d089…34f0`. The `Dockerfile`
of #21332 declares the argument, so the answer was not `unsupported`.
The same command on a tree with one changed range in
`packages/paperclip-runner/package.json` answered `lock: behind`, and
`resolve` then answered `inline (lock-behind)`.

Never run:

- `resolve --wait` in a workflow. No workflow calls it in this pull
request.
- The full test suite and the full typecheck. CI must supply them.

## Risks

- `resolve` now prints a notice for every `inline` answer. The
report-only job in `docker.yml` therefore shows one notice on each
`master` push whose Runner image is not published yet, until the next
pull request replaces the job. Nothing reads that job.
- `inputs` answers `unsupported` for a tree whose `Dockerfile` does not
declare `ARG PAPERCLIP_RUNNER_EXPECT_INPUTS_DIGEST` at the start of a
line. #21332 adds that line; a later edit that moves or renames it turns
every answer to `inline`.
- The wait is bounded by time from the push, not by its own duration. A
build that starts more than 40 minutes after the push looks once and
does not wait.
- A registry that does not answer adds at most about 3 minutes to one
lookup, because the registry client retries. A caller must give the step
more than 40 minutes. The next pull request gives it 55.

> For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and
discuss it in `#dev` before opening the PR. Feature PRs that overlap
with planned core work may need to be redirected — check the roadmap
first. See `CONTRIBUTING.md`.

## Model Used

- Claude Fable 5.2 (`claude-fable-5-2`), Anthropic, used through Claude
Code with tool use (shell, file edits, read-only calls to the GitHub API
and the container registry).

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-13 14:33:40 -08:00

23 KiB

Runner image contract

The Runner image is the Runner built alone, as a plain file tree with no entrypoint and no operating system. An image build copies paths out of it instead of compiling the Runner again. The application image of this repository takes its Runner from the stage that builds it (see "The application image"); no build reads the published image yet. Its name is ghcr.io/paperclipai/paperclip-runner, and one build makes two variants:

  • full, the runner-artifacts target of the Dockerfile: every path below;
  • slim, the runner-artifacts-slim target: the same without the two paths marked "full only", the provider pack's transport archives.

Layout

Every path a consumer may copy (RUNNER_IMAGE_PATHS in scripts/runner-image-layout.mjs). Every file is readable by every user.

Path Content
/runner-image.json Identity and description of this image.
/paperclip-runnerd The daemon. A stripped release binary, mode 0755.
/provider-pack/ The remote provider pack, with provider-pack.json.
/provider-pack.archive.json Full only. Receipt of the pack's transport archives.
/provider-pack.archives/ Full only. The transport archives the receipt lists.
/runner-package/package.json The Runner package manifest.
/runner-package/dist/ The Runner's complete build output. dist/bin/paperclip-runnerd is the same file as /paperclip-runnerd.
/runner-package/node_modules/.cache/paperclip-runner-build-inputs.json The build stamp the Runner's build recorded for that output.
/runner-package/scripts/provision-grok.mjs Provisions the native Grok executable. Reads platforms.json by relative path.
/runner-package/src/providers/grok/platforms.json The Grok release pins.
/runner-package/src/live/runnerd-codex-transport.ts The transport source, as a contract file. It defines RUNNER_CLIENT_VERSION.
/bundles/runnerd-codex-transport.mjs The pack's dist/live/runnerd-codex-transport.js as one module. It imports without node_modules.
/pnpm-lock.yaml The lockfile the image was installed from.

Paths under /runner-package/ keep their place inside packages/paperclip-runner. runner-image.json describes one platform, and is the same file in both variants:

  • inputsDigest (the identity below) and buildInputsDigest (the digest in the Runner's build stamp);
  • sourceRevision: the commit that built the image, also in the pack as payload.runnerSourceRevision. An image is published once for its inputs, so later commits with the same inputs keep this revision;
  • publication: true only for a build with the build argument PAPERCLIP_RUNNER_IMAGE_PUBLICATION=1. Only then does the pack carry the identity, as payload.runnerInputsDigest. Another image build that runs the stage inline builds the same Runner but is not this image;
  • platform (linux, amd64 or arm64) and libc: the glibc the daemon was compiled on (Debian bookworm, the oldest a consumer runs) and the newest glibc version it needs;
  • providerPack: the pack's digest and target;
  • paths and sha256: the table above, and the digest of every single file;
  • fullImageOnly: the names in paths that only the full image has.

Layers

  1. The pack's dependency files of 1 MiB or more: provider binaries and Node.
  2. Everything else, with runner-image.json.
  3. Full only: the transport archive of each file in layer 1.
  4. Full only: the other transport archives, the overlay archive, the receipt.

The slim image is layers 1 and 2. The full image is those same two layer blobs, then layers 3 and 4, which hold transport content and nothing else. Layers 1 and 3 have the same bytes in every build with the same dependency files, so a new image shares them with the one before it. A large file under the pack's dist is the Runner's own output: it and its archive are in layers 2 and 4. An archive is named by its file's place in the receipt, which lists the dependency files first, so their names do not depend on dist.

Identity

Both variants are named by one digest: the variant is not part of the identity. The full image has the tag inputs-<digest> and the slim image inputs-<digest>-slim. scripts/runner-image-identity.mjs computes the digest from:

  • every file under the paths the build copies from the build context (RUNNER_IMAGE_CONTEXT_INPUTS, which include pnpm-lock.yaml): path, executable bit and content, and each symbolic link by its target;
  • the whole Dockerfile: the recipe, the base image pinned by digest and the toolchain pins. Any edit to it makes a new image;
  • the two platforms, linux/amd64 and linux/arm64.

The source revision is not part of it, and neither is the text of .dockerignore: a rule changes the digest only when it changes which of those files the build receives. The build computes the digest for itself:

docker buildx build --target runner-artifacts-identity --output type=local,dest=/tmp/identity .
jq -r .digest /tmp/identity/runner-image-identity.json

The install is frozen. It fails when the lockfile is behind the manifests the build reads (the root one, packages/paperclip-runner and packages/paperclip-eval-kernel). A contributor cannot edit the lockfile, so pull-request runs resolve it first. For a local build, run pnpm install --resolution-only --ignore-scripts --no-frozen-lockfile.

Three places ask pnpm the same question, with the same arguments (runnerLockState in scripts/runner-image-publish.mjs):

  • the publication workflow, which publishes nothing for a lockfile that is behind;
  • the runner-lockfile stage of the Dockerfile, which fails an application image build and prints the command above. The application's dependency install starts from that stage, so it cannot start before the check passes. The Runner's toolchain and daemon stages do not depend on it, so they can already be running, and the failed check cancels them.
  • scripts/check-release-runner-lockfile.mjs, which scripts/release.sh runs for a beta and for a stable release. It checks the committed files of the release commit, so a beta or stable tag always builds with a plain docker build. A canary or a nightly is not checked.

Checks

CI builds each variant as an OCI archive and nothing else. node scripts/runner-image-oci.mjs unpack <oci archive> --out <tree> writes the tree of an image from its layers, so the tree CI checks is the bytes of the image. It refuses a whiteout, an absolute or .. path, a path written twice and an entry behind a link.

node scripts/runner-image-layout.mjs check <tree> --variant slim|full runs in the build and again on each unpacked tree. The variant has no default: a slim tree with the transport paths fails, and so does a full tree without them. The check fails unless:

  • every documented path exists, matches its digest in runner-image.json, and resolves inside the tree;
  • the build stamp names the inputs the identity names;
  • every artifact in provider-pack.json has its digest, the dist tree and each provider asset tree match their tree digests, and the pack names this image's revision and platform;
  • the pack names the inputs digest in a publication build and in no other. --expect-inputs-digest fails on any other build;
  • in a full image, every transport archive matches its receipt, and the archives extract to the pack. The check extracts them as a sandbox does (GNU tar with the options in provider-pack-layers.ts) and compares paths, content, link targets and all twelve permission bits, after the a+rX grant the build makes once the archives are written.

node scripts/runner-image-oci.mjs check-layers --slim <oci archive> --full <oci archive> checks "Layers" on the two archives, and that no file is in two layers.

The build also runs paperclip-runnerd --build-metadata on every base image in docker/runner-image/Dockerfile.smoke. Add a base there before a consumer uses it.

Consuming the image

Read the image only with COPY --from or a read-only bind mount (RUN --mount=type=bind,from=), and pin it by digest:

FROM ghcr.io/paperclipai/paperclip-runner@sha256:<digest> AS runner-artifacts
FROM debian:trixie-slim
COPY --from=runner-artifacts /paperclip-runnerd /usr/local/bin/paperclip-runnerd

A Dockerfile with a runner-artifacts or runner-artifacts-slim stage of its own, as in this repository, can take a built image or tree in its place with --build-context <stage>=<image or directory>. The stage is then not built.

The application image

The production and cloud targets of the Dockerfile read only the runner-artifacts stage, in two stages:

  • build copies /runner-package/dist and the build stamp into packages/paperclip-runner and sets PAPERCLIP_RUNNER_VENDOR_REQUIRE_CURRENT=1. The server build then vendors that output, and fails when the stamp does not match the Runner inputs of the tree it builds. The lockfile is one of those inputs.
  • runner-provider-pack copies /provider-pack, the receipt and the archives, and moves each pack file of 1 MiB or more to a tree of its own. production copies the three trees with the same three instructions as before, so the paths under /opt/paperclip-runner/ and the layers are the same. A deployed server finds the transport layer of an application image by the text of the instruction COPY --from=runner-provider-pack /provider-pack-transport/ /opt/paperclip-runner/ in the image history (retained-provider-pack-oci.ts). Do not change it.

No workflow replaces the stage yet, so every application image build runs the Runner stages itself: an inline Runner. An inline Runner is not this image, and an application image says so in three ways:

  • its pack names the build commit of the application image as payload.runnerSourceRevision, the value of PAPERCLIP_BUILD_COMMIT;
  • its pack has no payload.runnerInputsDigest;
  • the image has neither label of "Choosing the Runner for an image build".

A build without PAPERCLIP_BUILD_COMMIT has no pack, as before.

build also declares the build argument PAPERCLIP_RUNNER_EXPECT_INPUTS_DIGEST, which no build sets yet. It is for a build that replaces the stage with a published image. When the argument is set, scripts/check-runner-image-expectation.mjs reads /runner-image.json of the runner-artifacts the build was given, and the build fails unless that file has publication: true and names exactly those inputs. An inline Runner is never a publication, so the argument without the image fails too. The check runs before the server build vendors the Runner.

Choosing the Runner for an image build

scripts/runner-image-resolve.mjs decides whether a build of a checkout can copy the published image. No build uses its answer yet: on a master push, the runner_image_report job of .github/workflows/docker.yml runs it and writes the answer to the job summary, and nothing reads that job. The job runs on the committed files, holds no credential (the Runner package is public, so the lookup is anonymous) and cannot fail the run. The script has two commands, so that the one that builds reads no registry credential:

node scripts/runner-image-resolve.mjs inputs --dir "$dir"
node scripts/runner-image-resolve.mjs resolve --dir "$dir"

inputs exports the Runner build context, checks the lockfile and computes the inputs digest in the build, as the publication workflow does. Run it on the committed files, before any step that rewrites pnpm-lock.yaml. resolve looks up inputs-<digest> and reports:

  • mode: published or inline, and reason;
  • image and slim_image: both variants, pinned by index digest. The slim digest is the one the full index names (see "Pairing");
  • build_contexts: one --build-context value on each line, which replace the runner-artifacts and runner-artifacts-slim stages;
  • labels: io.paperclip.runner.image and io.paperclip.runner.inputs-digest, for the image that copies the Runner;
  • build_args: PAPERCLIP_RUNNER_EXPECT_INPUTS_DIGEST=<digest>, the build argument with which a build checks the Runner it is given.

published needs a complete publication whose full index names these inputs and both platforms. Every other answer is inline, with the last five values empty: the lockfile is behind the Runner's manifests (lock-behind), the image does not exist (absent), a publication is incomplete or broken, the full index does not match (mismatch), or the registry refused, failed or could not be reached (unknown). A tree whose Dockerfile declares no PAPERCLIP_RUNNER_EXPECT_INPUTS_DIGEST argument is inline too (unsupported): its build could not refuse a Runner of other inputs, so inputs runs no build for it. An inline build runs the Runner stages itself and carries neither label. For an inline answer resolve prints a notice with the reason. The command does not verify the attestation of the image: the workflow that uses the answer does.

Waiting for a publication

A master push starts its own run of .github/workflows/runner-image.yml, which may still be publishing when an image build of the same commit asks. resolve --dir "$dir" --wait is for that build. When the first answer is absent or incomplete, it lists the runs of that workflow for the push of GITHUB_SHA to master (the Actions API, with GITHUB_TOKEN and actions: read) and looks again when they end. Only a run of the push event on master in this repository counts: a run of the same commit for a pull request, for the weekly schedule or from a manual start publishes nothing and is never waited for. Every other first answer is final and starts no wait.

  • A run, not a time. When every run of the commit has completed, the command looks up the image once more, and that answer is final. A run that failed, was cancelled, or published nothing because the lockfile is behind ends the wait as soon as it ends.
  • Published before the run ends. While a run is in progress the command looks up the image every 30 seconds. The wait ends when the image is published, not when the last job of the run ends.
  • Not listed yet. A run can be missing from the list just after the push. The command looks for it for two minutes, measured from the start of the wait. A commit with no run by then is not the head of a master push.
  • Limit. The wait ends 40 minutes after the push (RUNNER_IMAGE_WAIT_MINUTES in the script). The push is the creation time of the oldest run of the commit, so a build that starts late waits less, and one that starts after the limit looks once and does not wait.
  • Actions API. Three failed requests in a row end the wait. Without a token or a full commit SHA there is no wait.
  • Never an error. After every ending the command looks up the image one last time. Without an image the answer is inline, with the reason of that lookup and what the wait saw.

Publication

.github/workflows/runner-image.yml publishes on a master push in this repository and nowhere else. Other runs build and check, and publish nothing.

  • Lockfile. A master push builds from the committed pnpm-lock.yaml, so the digest is a function of the commit. When that file is behind the Runner's manifests, the run writes a notice, publishes nothing and stays green. The commit that merges the lockfile refresh publishes the image.
  • Once. The build runs only when inputs-<digest> does not exist.
  • Verified bytes. The build legs cannot write to the registry. The publish job pushes the images they checked by digest and joins each variant into a multi-platform index under a candidate- tag. It attests both indexes, and only then writes the two inputs- tags. candidate- tags are internal: one can name an index that is not attested, and the next run overwrites it. Do not consume them.
  • Order. It writes inputs-<digest>-slim first and inputs-<digest> last, so the full tag marks a complete publication. The full index names its slim index in the annotation io.paperclip.runner.slim-digest.
  • Pairing. Resolve the full tag first. Take the slim digest from that annotation of the full index, and pull the slim image by that digest. Never resolve inputs-<digest>-slim by tag on its own: while a publication is incomplete, that tag can name the slim image of another run.
  • Recovery. A run that stops between the two tags leaves a slim tag alone. Those inputs are not published. The next run for them builds again, replaces that tag with its own slim image and then writes the full tag. A full tag whose slim tag is missing or names another image fails every run for those inputs. An operator must then delete both package versions and re-run the workflow run of a master push with those inputs.
  • Create-only. The workflow never moves a tag of a complete publication, but the registry does not enforce that. Pin the index digest and verify it: gh attestation verify oci://ghcr.io/paperclipai/paperclip-runner@sha256:<digest> --repo paperclipai/paperclip --signer-workflow paperclipai/paperclip/.github/workflows/runner-image.yml --source-ref refs/heads/master
  • First publication. GitHub creates the package private. A maintainer must make it public once.

Build cache

The build legs read a registry build cache, ghcr.io/paperclipai/paperclip-runner-buildcache:<arch>. It is a package of its own and holds no image, so the image package holds only attested images. It covers the stages that do not take the commit: the Rust toolchain and the compiled daemon. The last stage takes the source revision as a build argument, so every build runs it: the frozen install, the Runner's build and the provider pack. Of the two build commands of a leg, only the first reads the registry cache; the second reads what the first left in the job's builder.

  • Effect. BuildKit reuses a cached step only when the step and the content of every file it reads are the same. The cache changes how long a build takes, not what it builds, and the identity does not cover it.
  • Writer. Only the cache job of the workflow writes it: on a master push in this repository, after the publish job, for inputs that had no image. When the image exists, nothing was built, and the run that published it wrote the cache for those inputs. That job cannot sign, builds no further than the daemon and never runs the install. Its token reaches the registry login and no other step. It reads the cache it writes and keeps every step of the cached stages (mode=max). Every other run reads the cache without a credential and cannot write it.
  • Not on the way to an image. No job waits for the cache job. When it fails, the image is published and the next build is slower.
  • One write at a time. The job holds one concurrency slot for each architecture. GitHub keeps one waiting job in a group and cancels the one that waited before it, so the newest write waits. A write from an older commit that lands last costs time and nothing else.
  • No Actions cache. The workflow never uses it: workflows that handle pull requests can write it, and what they write must not reach a published image.
  • Trust. The daemon in a published image can come from a cached step that an earlier master run compiled. Whoever can write the cache package can decide what a later build reuses, so write access to it must stay as narrow as write access to the image package.
  • Fetches. A cached step does not run again. A download inside one (the toolchain installer, the toolchain, the crates) is not repeated until the inputs of that step change.
  • Weekly cold build. A scheduled run builds both variants once a week with no cache: it passes --no-cache and reads no registry cache. Like a manual run, it resolves the lockfile, always builds, runs every check and publishes nothing. A fork's schedule runs nothing. It fails when a download is gone or when a step only works from the cache.
  • Missing cache. A cache that does not exist or cannot be read is a line in the build log, not a failure. The build then runs every step.
  • First write. GitHub creates the cache package private. A maintainer must make it public once. Until then every build runs cold.

Reading the transport archives alone

The server needs the transport form of an older pack when a retained session names a pack that is not the server's own. A pack with payload.runnerInputsDigest came out of this image, so the server reads it from inputs-<digest> (retained-provider-pack-oci.ts). It does not count layers. It uses the rule of "Layers": the full image is the slim image, then layers that hold transport content and nothing else.

  • The full index must carry the annotations io.paperclip.runner.inputs-digest, equal to the pack's digest of inputs, org.opencontainers.image.revision, equal to the pack's runnerSourceRevision, and io.paperclip.runner.slim-digest.
  • The server reads the slim index by that digest, never by the slim tag, and checks the bytes against the digest.
  • For the pack's platform, the layers of the slim image must be the first layers of the full image, as the same blobs in the same order. The layers after them are the transport layers: at least one and at most eight.
  • The server downloads only those layers. It refuses any entry in them that is not a transport archive or the receipt, and any file that is in two of them.
  • The importer then checks every archive against the pack's manifest, as for any other source.
  • The record the server keeps of the source names the digest of inputs and every transport layer under runnerImage. Its transportLayerDigest is then the last of those layers and transportLayerBytes their total.

When the image cannot be read (a tag or the slim index does not exist, or the registry refuses a request), the server reads the application image tagged sha-<runnerSourceRevision>, as it does for a pack without runnerInputsDigest. An image that can be read and does not match fails.

Known limits

  • A build without PAPERCLIP_RUNNER_SOURCE_REVISION or PAPERCLIP_BUILD_COMMIT has no pack. It is for local use.
  • The build runs the steps of the Runner's build script that write output, not its drift checks; repository CI runs those.
  • A build that vendors /runner-package/ reuses dist only when its own Runner build-inputs digest equals the stamp's. The image computes that digest in the .dockerignore-filtered context; a checkout gives another.
  • # syntax=docker/dockerfile:1.20 is a tag. A new frontend release under it does not change the identity.
  • The archive check does not tell a directory with its own archive member from one created only as a file's parent.
  • A lockfile that the lockfile refresh cannot bring up to the Runner's manifests leaves every master run green with only a notice, for as long as it lasts. No image is published in that time, and nothing fails.