Deployment & Publishing

How docs and packages are released, and what maintainers need to do before merge.

Overview

This repo uses three primary GitHub workflows:

  • .github/workflows/ci.yml for pull-request validation on Node 24. Require the PR validation (Node 24) check in branch protection; see docs/ci.md for owner setup.
  • .github/workflows/docs.yml for docs build/deploy and Algolia indexing.
  • .github/workflows/release.yml for package versioning and publishing via Changesets.

Changesets workflow

Add a changeset whenever a publishable package change should be versioned.

pnpm changeset

On merge to main, the release workflow does one of the following:

  • Pending changesets: opens/updates a version PR.
  • No pending changesets: publishes changed packages.

Package release workflow

The release workflow runs format, lint, test, then builds publishable packages (www excluded) before running Changesets action.

Manual local release commands

pnpm changeset-version && pnpm changeset-publish

Publishing targets GitHub Packages for the @branditdev scope.

Docs deployment workflow

Docs deployment runs on merges to main (and manual trigger). It generates docs artifacts, builds, deploys to Vercel, then updates Algolia.

Local parity checks

pnpm ci:check && pnpm ci:build

Maintainer checklist

  • Add changeset for publishable package changes.
  • Run docs generation when API/docs content changes.
  • Ensure CI passes before merge.
  • Verify release/docs workflows after merging to main.