Usando Changesets com pnpm

nota

No momento da redação desta documentação, a versão mais recente do pnpm era v6.14. A versão mais recente do Changesets era v2.16.0.

Configuração

Para configurar o changesets num ambiente pnpm, instale changesets como uma dependência de desenvolvimento na raiz do ambiente:

pnpm add -Dw @changesets/cli

Em seguida, o comando de inicialização do changesets:

pnpm changeset init

Adicionando novos changesets

Para gerar um novo changeset, execute pnpm changeset na raiz do repositório. Os arquivos markdown gerados no diretório .changeset devem ser commitados no repositório.

Publicando changesets

1. Execute pnpm changeset version. Isso irá incrementar as versões dos pacotes previamente especificados com pnpm changeset (e quaisquer dependências dos mesmos) e atualizar os arquivos de changelog.
2. Execute pnpm install. Isto irá atualizar o lockfile e reconstruir pacotes.
3. Faça um commit das alterações.
4. Execute pnpm publish -r. Esse comando irá publicar todos os pacotes que possuem versões com colisão ainda não presentes no registro.

Usando GitHub Actions

Para automatizar o processo, você pode usar a changeset version com GitHub Actions.

Atualizando as versões do pacote

A ação detectará quando arquivos de changeset chegarem na branch main e, em seguida, abrirá um novo Pull Request listando todos os pacotes com versões alteradas. Uma vez mesclados, os pacotes serão atualizados e você poderá decidir se deseja publicar ou não adicionando a propriedade publish.

Publicando

Adicione um novo script ci:publish que executa pnpm publish -r. Assim quando for feito o merge da PR criada pelo comando changeset version o pacote será publicado no registry.

package.json

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

name: Changesets
on:
  push:
    branches:
      - main
env:
  CI: true
  PNPM_CACHE_FOLDER: .pnpm-store
jobs:
  version:
    timeout-minutes: 15
    runs-on: ubuntu-latest
    steps:
      - name: checkout code repository
        uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: setup node.js
        uses: actions/setup-node@v3
        with:
          node-version: 14
      - name: install pnpm
        run: npm i pnpm@latest -g
      - name: Setup npmrc
        run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > .npmrc
      - name: setup pnpm config
        run: pnpm config set store-dir $PNPM_CACHE_FOLDER
      - name: install dependencies
        run: pnpm install
      - name: create and publish versions
        uses: changesets/action@v1
        with:
          version: pnpm ci:version
          commit: "chore: update versions"
          title: "chore: update versions"
          publish: pnpm ci:publish
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Mais informações e documentação sobre essa ação podem ser encontradas aqui.