feat: publish releases to GitHub Packages npm registry

Author: obcode

.github/workflows/release.yml

@@ -9,6 +9,7 @@ permissions:
   contents: write
   issues: write
   pull-requests: write
+  packages: write
 
 jobs:
   release:
@@ -29,11 +30,14 @@ jobs:
         with:
           node-version: 20
           cache: pnpm
+          registry-url: https://npm.pkg.github.com
+          scope: '@obcode'
 
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
 
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: pnpm run release

.releaserc.json

@@ -9,6 +9,12 @@
         "changelogFile": "CHANGELOG.md"
       }
     ],
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": true
+      }
+    ],
     "@semantic-release/github",
     [
       "@semantic-release/git",

README.md

@@ -8,6 +8,12 @@ Reusable CLI toolkit for Slidev-based lecture repositories.
 pnpm add -D github:obcode/lecture-toolkit-cli#v0.1.0
 ```
 
+via GitHub Packages (npm registry):
+
+```bash
+pnpm add -D @obcode/lecture-toolkit-cli
+```
+
 or run on demand:
 
 ```bash
@@ -97,9 +103,19 @@ This repository is configured for Semantic Release via GitHub Actions.
 - Config: `.releaserc.json`
 - Trigger: push to `main`
 
-Required GitHub repository secrets:
+The release workflow publishes:
 
-- no extra secrets required (uses `GITHUB_TOKEN`)
+- Git tag + GitHub Release
+- npm package to GitHub Packages (`npm.pkg.github.com`)
+
+No extra secrets are required for same-repo publishing. The workflow maps `NPM_TOKEN` to `GITHUB_TOKEN` and requires `packages: write` permission.
+
+To consume the package from GitHub Packages, configure `.npmrc` in the consuming repo or user profile:
+
+```ini
+@obcode:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
+```
 
 Use Conventional Commits for release versioning, for example:
 

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "lecture-toolkit-cli",
+  "name": "@obcode/lecture-toolkit-cli",
   "version": "0.1.0",
   "description": "Reusable CLI toolkit for Slidev lecture repositories",
   "type": "module",
@@ -18,12 +18,16 @@
   "scripts": {
     "release": "semantic-release"
   },
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com"
+  },
   "packageManager": "pnpm@10.33.0",
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^13.0.1",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^11.0.6",
+    "@semantic-release/npm": "^12.0.2",
     "@semantic-release/release-notes-generator": "^14.1.0",
     "semantic-release": "^24.2.9"
   }