Publish snapshots from CI

kubb studio snapshot generates a package on a CI runner, publishes it to Studio, and exits. Run snapshots on pull or merge requests and the default branch so reviewers can compare their output.

Set the token

Create an organization CI API key in Studio and store it as KUBB_TOKEN. On GitHub, use an Actions secret. On GitLab, use a masked CI/CD variable. Snapshot installation uses a separate registry API key.

Snapshots expire after seven days. Schedule a default-branch run if it can go a week without a push.

GitHub Actions

Follow Publish snapshots with GitHub Actions for a workflow that publishes snapshots and comments on pull requests. The action reference lists its inputs and outputs.

GitLab CI

Follow Publish snapshots with GitLab CI for the job and an optional script that posts a merge request note.

Other CI providers

For a provider without automatic agent identification, use a stable --id on the base branch and pass it as --base-id on pull request runs:

Terminal

kubb studio snapshot --id jenkins:api:main                              # on main
kubb studio snapshot --id jenkins:api:pr-12 --base-id jenkins:api:main  # on a pull request

Use kubb studio snapshot --json | jq -r '.url' to pass the tarball URL to another step. See CI agent identity for automatic provider detection and Snapshot output for the result fields.

Install the snapshot

Configure the registry API key, then run the install command from the snapshot result:

.npmrc

//kubb.studio/:_authToken=${KUBB_REGISTRY_TOKEN}