@alanlu-dev/release-it-config

A release-it configuration for monorepo.

Installation

1pnpm add -wD @alanlu-dev/release-it-config

Usage

Create a .release-it.cjs file in the root of your project:

1module.exports = require('@alanlu-dev/release-it-config')

Add the following scripts to the package.json of the package:

1{
2  "scripts": {
3    "release": "release-it --ci"
4  }
5}

Add the following scripts to the package.json in the root directory:

1{
2  "scripts": {
3    "release": "turbo release --concurrency=1"
4  }
5}

CI/CD

You can use the following GitHub Actions workflow to automate the release process:

1name: Release & Publish
2on:
3  workflow_dispatch:
4  push:
5    branches: main
6
7permissions: {}
8jobs:
9  release:
10    name: Release
11    permissions:
12      contents: write # to create release (changesets/action)
13    timeout-minutes: 20
14    runs-on: ubuntu-latest
15
16    steps:
17      - name: Checkout
18        uses: actions/checkout@v4
19        with:
20          fetch-depth: 0
21
22      - name: Install pnpm
23        uses: pnpm/action-setup@v3
24
25      - name: Use Node.js 20
26        uses: actions/setup-node@v4
27        with:
28          node-version: 20
29          cache: pnpm
30
31      - name: Setup turbo cache
32        uses: actions/cache@v4.0.2
33        with:
34          path: .turbo
35          key: turbo-${{ github.ref_name }}-${{ github.sha }}
36          restore-keys: |
37            turbo-${{ github.ref_name }}-
38            turbo-main-
39
40      - name: Install deps
41        if: steps.node-cache.outputs.cache-hit != 'true'
42        run: pnpm install --prefer-offline --frozen-lockfile
43
44      - name: Build
45        run: pnpm run build
46
47      - name: Setup git user
48        run: |
49          git config user.name "$GIT_USER_NAME"
50          git config user.email "$GIT_USER_EMAIL"
51        env:
52          GIT_USER_NAME: ${{ vars.GIT_USER_NAME }}
53          GIT_USER_EMAIL: ${{ vars.GIT_USER_EMAIL }}
54
55      - name: Setup npm auth
56        run: echo "//npm.pkg.github.com/:_authToken=${NPM_TOKEN}" > ~/.npmrc
57        env:
58          NPM_TOKEN: ${{ secrets.MY_GITHUB_TOKEN }}
59
60      - name: Setup ssh key
61        uses: shimataro/ssh-key-action@v2.7.0
62        with:
63          key: ${{ secrets.SSH_KEY }}
64          known_hosts: github.com
65
66      - name: Run Release
67        run: pnpm release --cache-dir=.turbo
68        env:
69          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}