Kubb v5.4.1

GitHub Actions ​

kubb-labs/action runs kubb studio snapshot on every pull request and publishes the package to Kubb Studio. A reviewer installs the tarball from the comment it posts.

Kubb Studio

From spec to production.

Generate typed clients, review every change, and automate your OpenAPI workflow from local development to CI. Your code stays on your infrastructure.

Try Kubb Studio Connect a project Create snapshots

Add the workflow ​

.github/workflows/kubb.yml
yaml
name: Kubb snapshot

on:
  pull_request:
  # A snapshot of main is what pull requests compare with.
  push:
    branches: [main]

permissions:
  contents: write
  pull-requests: write

# Runs of one pull request or branch share a Studio agent, so run them one at a time.
concurrency:
  group: kubb-snapshot-${{ github.ref }}
  cancel-in-progress: true

jobs:
  snapshot:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: kubb-labs/action@v1
        with:
          token: ${{ secrets.KUBB_TOKEN }}

pull-requests: write covers the comment. contents: write is only needed for the init pull request below.

Set the token ​

Create KUBB_TOKEN, an organization CI API key, in Studio's settings. Add it under Settings > Secrets and variables > Actions.

Inputs ​

Input Default Description
token Organization CI API key. Required.
github-token ${{ github.token }} Token that opens the init pull request and writes the snapshot comment.
working-directory . Directory holding the Kubb config and the package.
config kubb.config.ts Path to the config file, relative to working-directory.

Outputs ​

Output Description
snapshot-id ID Studio stored the snapshot under.
package-name Name of the generated package.
package-version Version of the generated package.
tarball-url URL of the generated tarball.
integrity SHA-512 integrity of the tarball.
agent-url Studio URL of the CI agent that ran the job.
files-added, files-changed, files-removed Generated files added, changed, and removed since the previous snapshot on the pull request.

Give the step an id, then read an output as ${{ steps.snapshot.outputs.tarball-url }} (using snapshot as the step ID).

What a run does ​

kubb runs from the repository's own node_modules/.bin/kubb when there is one, so the snapshot matches the version your config and plugins are built against. Otherwise it falls back to npx. One CI agent and one comment are reused per pull request, and one per branch.

What the comment shows ​

Below the install command, the comment lists which generated files changed:

Section Compared with
Changes against main The latest snapshot of the base branch, from the push trigger
Changes since abc1234 The previous snapshot on the same pull request

Snapshots expire after seven days, so add a schedule trigger if main can go a week without a push. A failed snapshot shows its error in the comment.

Two runs end early, and neither is a failure. A fork pull request has no secrets. A repository with no kubb.config.ts gets an init pull request titled chore: initialize Kubb, and the next run after you merge it generates a snapshot.

Install the snapshot ​

The download needs a registry API key, not the ci key that created the snapshot.

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

See also ​