Skip to content
Integrations

Publish Kubb snapshots with GitHub Actions

Add the kubb-labs/action workflow to publish a Kubb Studio snapshot on each pull request and compare generated files with the base branch and the previous run.

The kubb-labs/action publishes a Studio snapshot on each pull request. Its comment lists the generated files that changed against the base branch and the previous run. Meet the prerequisites first: Kubb 5.6.2 or later, tsdown, and a CI key stored as KUBB_TOKEN.

Add the workflow

Store KUBB_TOKEN as an Actions repository secret, then add this workflow:

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

on:
  pull_request:
    # `closed` deletes the pull request's Studio agent. GitHub leaves it out by default.
    types: [opened, synchronize, reopened, closed]
  # Each pull request compares with a snapshot of its base branch, so list every branch pull requests target.
  push:
    branches: [main, 'release/**']

permissions:
  contents: write
  pull-requests: write

jobs:
  snapshot:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: kubb-labs/action@v0
        with:
          token: ${{ secrets.KUBB_TOKEN }}
GitHub does not give secrets to workflows from fork pull requests, so the action skips the snapshot on those and logs why. Pull requests from branches in the repository get a snapshot.
PermissionLets the action
pull-requests: writePost and update the snapshot comment.
contents: writeOpen an initialization pull request when the repository has no Kubb config. Also turn on Allow GitHub Actions to create and approve pull requests under Settings › Actions › General.

The GitHub Action reference lists inputs, outputs such as tarball-url, and runtime behavior.

To install a snapshot or read it in Studio, see Review the snapshot and Install the snapshot.