feat: add semantic-release

Author: jameswiltshire

.github/workflows/release.yml

@@ -9,17 +9,30 @@ jobs:
   ci:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
-      - uses: actions/setup-node@v5
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Setup Node.js 22 (cache npm)
+        uses: actions/setup-node@v5
         with:
           node-version: 22
           cache: npm
           registry-url: https://registry.npmjs.org
-      - run: npm ci
-      - run: npm run format:check
-      - run: npm run lint
-      - run: npm run build
-      - run: npm test
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Check formatting
+        run: npm run format:check
+
+      - name: Run linter
+        run: npm run lint
+
+      - name: Build project
+        run: npm run build
+
+      - name: Run tests (with coverage)
+        run: npm test
 
   publish:
     if: github.ref == 'refs/heads/main'
@@ -29,14 +42,27 @@ jobs:
       contents: write
       id-token: write
     steps:
-      - uses: actions/checkout@v5
-      - uses: actions/setup-node@v5
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Setup Node.js 22 (cache npm)
+        uses: actions/setup-node@v5
         with:
           node-version: 22
           cache: npm
           registry-url: https://registry.npmjs.org
-      - run: npm ci
-      - run: npm run build
-      - run: npm publish --provenance --access public
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build project (before release)
+        run: npm run build
+
+      - name: Verify provenance attestations and registry signatures
+        run: npm audit signatures
+
+      - name: Run semantic-release
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

.releaserc.cjs

@@ -0,0 +1,23 @@
+module.exports = {
+  branches: ["main"],
+  plugins: [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/changelog",
+      {
+        changelogFile: "CHANGELOG.md",
+      },
+    ],
+    [
+      "@semantic-release/npm",
+      {
+        // keep npmPublish true to publish to npm,
+        // but we are NOT using @semantic-release/git so package.json
+        // won't be committed back to the repo.
+        npmPublish: true,
+      },
+    ],
+    "@semantic-release/github",
+  ],
+};