Setup​

To setup changesets on a pnpm workspace, install changesets as a dev dependencyin the root of the workspace:

pnpm add -Dw @changesets/cli

Then run changesets' init command to generate a changesets config:

pnpm changeset init

Adding new changesets​

To generate a new changeset, runpnpm changeset in the root of the repository.The generated markdown files in the.changeset directory should be committedto the repository.

Releasing changes​

1. Runpnpm changeset version. This will bump the versions of the packagespreviously specified withpnpm changeset (and any dependents of those) andupdate the changelog files.
2. Runpnpm install. This will update the lockfile and rebuild packages.
3. Commit the changes.
4. Runpnpm publish -r. This command will publish all packages that havebumped versions not yet present in the registry.

Integration with GitHub Actions​

To automate the process, you can usechangeset version with GitHub actions. The action will detect when changeset files arrive in themain branch, and then open a new PR listing all the packages with bumped versions. The PR will automatically update itself every time a new changeset file arrives inmain. Once merged the packages will be updated, and if thepublish input has been specified on the action they will be published using the given command.

Add a publish script​

Add a new script calledci:publish which executespnpm publish -r. This will publish to the registry once the PR created bychangeset version has been merged. If the package is public and scoped, adding--access=public may be necessary to prevent npm rejecting the publish.

package.json

{
"scripts":{
"ci:publish":"pnpm publish -r"
},
   ...
}

Add the workflow​

Add a new workflow at.github/workflows/changesets.yml. This workflow will create a new branch and PR, so Actions should be givenread and write permissions in the repo settings (github.com/<repo-owner>/<repo-name>/settings/actions). If including thepublish input on thechangesets/action step, the repo should also include an auth token for npm as a repository secret namedNPM_TOKEN.

.github/workflows/changesets.yml

name: Changesets

on:
push:
branches:
- main

env:
CI:true

jobs:
version:
timeout-minutes:15
runs-on: ubuntu-latest
steps:
-name: Checkout code repository
uses: actions/checkout@v4

-name: Setup pnpm
uses: pnpm/action-setup@v4

-name: Setup node.js
uses: actions/setup-node@v4
with:
node-version:20
cache:'pnpm'

-name: Install dependencies
run: pnpm install

-name: Create and publish versions
uses: changesets/action@v1
with:
commit:"chore: update versions"
title:"chore: update versions"
publish: pnpm ci:publish
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN}}
NPM_TOKEN: ${{ secrets.NPM_TOKEN}}

More info and documentation regarding the changesets action can be foundhere.