catalog-update-action

Automated dependency updates for Bun's catalog: protocol. Replaces Dependabot for monorepos using Bun workspaces with a centralized catalog.

Why

Dependabot doesn't understand Bun's catalog: protocol — it can't update the centralized version catalog in your root package.json. This action fills that gap.

Features

• Reads the catalog field from your root package.json
• Queries npm for the latest stable versions (skips pre-releases)
• Groups updates into batches based on configurable patterns (similar to Dependabot groups)
• Creates and syncs PRs via the GitHub CLI — closes stale ones, rebuilds conflicting ones
• Includes release notes from GitHub Releases in PR descriptions
• Supports ^ ranges and npm: aliases
• Detects vulnerable transitive dependencies via bun audit and creates override PRs
• Runs as a GitHub Action or standalone CLI

Prerequisites

• Bun runtime
• gh CLI (pre-installed on GitHub Actions runners)
• GITHUB_TOKEN with contents: write and pull-requests: write permissions

Usage

GitHub Action

# .github/workflows/catalog-update.yml
name: Catalog Updates
on:
  schedule:
    - cron: '0 6 * * 1-5'  # Weekdays at 06:00 UTC
  workflow_dispatch:

permissions:
  contents: write
  pull-requests: write

jobs:
  update:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - uses: brandhaug/catalog-update-action@v1
        with:
          config: '.catalog-updaterc.json'
          dry-run: 'false'

Tip: PRs created with the default GITHUB_TOKEN won't trigger downstream workflows (e.g., CI checks). To fix this, use a GitHub App token:

steps:
  - uses: actions/create-github-app-token@v1
    id: app-token
    with:
      app-id: ${{ secrets.APP_ID }}
      private-key: ${{ secrets.APP_PRIVATE_KEY }}

  - uses: actions/checkout@v4
    with:
      fetch-depth: 0
      token: ${{ steps.app-token.outputs.token }}

  - uses: brandhaug/catalog-update-action@v1
    with:
      token: ${{ steps.app-token.outputs.token }}

Action Inputs

Input	Default	Description
config	.catalog-updaterc.json	Path to the config file
dry-run	false	Preview updates without creating PRs
token	github.token	GitHub token for creating PRs. Use a PAT or GitHub App token to trigger downstream workflows

CLI

# Run via bunx (no install needed)
bunx catalog-update-action --dry-run

# Or via npx
npx catalog-update-action --dry-run

# Install globally
bun add -g catalog-update-action
catalog-update --dry-run

# Full run (creates PRs)
catalog-update

# Custom config path
catalog-update -c path/to/.catalog-updaterc.json

CLI Options

Flag	Short	Description
--help	-h	Show help message and exit
--version	-v	Show version and exit
--dry-run	-d	Preview updates without creating PRs
--config <path>	-c	Path to config file (default: .catalog-updaterc.json)

Configuration

Create a .catalog-updaterc.json in your repository root:

{
  "$schema": "https://raw.githubusercontent.com/brandhaug/catalog-update-action/master/schema.json",
  "branchPrefix": "catalog-update",
  "defaultBranch": "master",
  "maxOpenPrs": 20,
  "concurrency": 10,
  "packageManager": "bun",
  "groups": [
    { "name": "react", "patterns": ["react", "react-dom"] },
    { "name": "vite", "patterns": ["vite", "vitest", "@vitejs/*", "@vitest/*"] },
    { "name": "storybook", "patterns": ["@storybook/*", "storybook*"] },
    { "name": "all-patch-updates", "patterns": ["*"], "updateTypes": ["patch"] }
  ],
  "ignore": [
    { "pattern": "*storybook*", "updateTypes": ["major"] }
  ],
  "audit": {
    "enabled": true,
    "minimumSeverity": "moderate"
  }
}

Tip: Add the $schema field to get autocomplete and validation in your IDE.

Options

Option	Type	Default	Description
branchPrefix	string	"catalog-update"	Prefix for PR branches (e.g., catalog-update/react)
defaultBranch	string	"master"	Base branch for PRs
maxOpenPrs	number	20	Maximum number of open PRs at any time
concurrency	number	10	Max concurrent npm registry requests
packageManager	string	"bun"	Package manager for lockfile updates (bun, npm, pnpm, yarn)
groups	array	[]	Dependency grouping rules (see below)
ignore	array	[]	Dependency ignore rules (see below)
audit	object	{}	Transitive vulnerability audit settings (see below)

Groups

Groups control how updates are batched into PRs. Each group has:

• name — Group identifier, used in branch names and PR titles
• patterns — Glob patterns to match package names (* wildcard supported)
• updateTypes (optional) — Restrict to specific semver change types: "major", "minor", "patch". Omit to match all types

Groups are evaluated in order — first match wins. A common pattern is to have specific groups first and a catch-all all-patch-updates group last:

{
  "groups": [
    { "name": "react", "patterns": ["react", "react-dom"] },
    { "name": "testing-library", "patterns": ["@testing-library/*"] },
    { "name": "all-patch-updates", "patterns": ["*"], "updateTypes": ["patch"] }
  ]
}

Packages not matched by any group get individual PRs.

Patch collapse: If a named group (e.g. sentry) contains only patch updates and no minor or major updates, its members are automatically moved into all-patch-updates instead of getting a separate PR. This reduces PR noise — a dedicated group PR is only created when it has at least one minor or major update. For this to work, you need an all-patch-updates catch-all group with "updateTypes": ["patch"] as the last group.

Ignore Rules

Ignore rules prevent certain updates from being created:

• pattern — Glob pattern to match package names
• updateTypes (optional) — Only ignore specific change types. Omit to ignore all updates for matched packages

{
  "ignore": [
    { "pattern": "*storybook*", "updateTypes": ["major"] },
    { "pattern": "typescript" }
  ]
}

Vulnerability Audit

When enabled, the action runs bun audit --json to detect vulnerable transitive dependencies and creates a PR that adds overrides to your package.json, pinning transitive dependencies to patched versions.

• enabled — Enable or disable the audit pipeline (default: true)
• minimumSeverity — Minimum advisory severity to act on: "info", "low", "moderate", "high", "critical" (default: "moderate")

{
  "audit": {
    "minimumSeverity": "high"
  }
}

To disable the audit entirely:

{
  "audit": {
    "enabled": false
  }
}

The override PR is created with security priority (before catalog PRs) and shares the same maxOpenPrs budget. Direct catalog dependencies are excluded from overrides since they are handled by the catalog update pipeline.

How It Works

1. Parse — Reads the catalog field from root package.json, extracting package names and current versions (supports ^ ranges and npm: aliases)
2. Query — Fetches latest stable versions from the npm registry (skips pre-releases)
3. Filter — Applies ignore rules and classifies updates as major/minor/patch
4. Group — Assigns updates to configured groups; unmatched packages get individual PRs
5. Audit — If audit is enabled, runs bun audit --json to find vulnerable transitive dependencies and computes required overrides
6. Sync — For existing PRs: closes stale ones, rebuilds conflicting or outdated ones
7. Create — Creates new PRs (override PR first for security priority, then catalog PRs), respecting the maxOpenPrs limit

Each catalog PR includes:

• A table of all updated packages with version changes
• Release notes fetched from GitHub Releases (with intermediate version support for monorepos)

Each override PR includes:

• A summary table of overridden packages with fixed versions and advisory links
• Collapsible advisory details (severity, CVSS score, CWE, vulnerable version ranges)

Contributing

Contributions are welcome! To get started:

git clone https://github.com/brandhaug/catalog-update-action.git
cd catalog-update-action
bun install
bun test

License

MIT — see LICENSE for details.