Set up NPM trusted publishing #389

ref DEV-3099

Author: tung2744

.github/workflows/ci.yaml

@@ -11,22 +11,31 @@ on:
     branches:
     - '*'
     - '!gh-pages'
+    tags:
+    - '*'
   pull_request:
     branches:
     - '*'
     - '!gh-pages'
 
+# https://docs.npmjs.com/trusted-publishers#step-2-configure-your-cicd-workflow
+permissions:
+  id-token: write
+  contents: read
+
 jobs:
   test:
     runs-on: macos-15
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
+    - uses: actions/setup-node@v6
       with:
         node-version-file: "./.tool-versions"
     - uses: ruby/setup-ruby@v1
       with:
         bundler-cache: true
+    - run: node --version
+    - run: npm --version
     - run: make ruby-audit
     - run: sudo xcode-select -s /Applications/Xcode_16.4.app/Contents/Developer
     - run: npm ci
@@ -49,11 +58,37 @@ jobs:
       if: ${{ !cancelled() }}
     - run: npm run verify
       if: ${{ !cancelled() }}
-    - run: npm run bundle
+    - run: npm run build
       if: ${{ !cancelled() }}
     - run: make docs
       if: ${{ !cancelled() }}
 
+  publish:
+    if: ${{ github.ref_type == 'tag' }}
+    runs-on: macos-15
+    needs: test
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v6
+      with:
+        node-version-file: "./.tool-versions"
+    - run: node --version
+    - run: npm --version
+    - run: npm ci
+    - run: npm run build
+    - run: ../../scripts/npm-publish.sh
+      working-directory: ./packages/authgear-web/
+      env:
+        GITHUB_REF_NAME: ${{ github.ref_name }}
+    - run: ../../scripts/npm-publish.sh
+      working-directory: ./packages/authgear-react-native/
+      env:
+        GITHUB_REF_NAME: ${{ github.ref_name }}
+    - run: ../../scripts/npm-publish.sh
+      working-directory: ./packages/authgear-capacitor/
+      env:
+        GITHUB_REF_NAME: ${{ github.ref_name }}
+
   webapp-image:
     runs-on: ubuntu-24.04
     needs: test
@@ -78,7 +113,7 @@ jobs:
     runs-on: macos-15
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
+    - uses: actions/setup-node@v6
       with:
         node-version-file: "./.tool-versions"
     - run: make sdk-build
@@ -89,7 +124,7 @@ jobs:
     runs-on: macos-15
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
+    - uses: actions/setup-node@v6
       with:
         node-version-file: "./.tool-versions"
     - uses: ruby/setup-ruby@v1
@@ -105,7 +140,7 @@ jobs:
     runs-on: macos-15
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
+    - uses: actions/setup-node@v6
       with:
         node-version-file: "./.tool-versions"
     - run: make sdk-build
@@ -122,7 +157,7 @@ jobs:
     runs-on: macos-15
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
+    - uses: actions/setup-node@v6
       with:
         node-version-file: "./.tool-versions"
     - uses: ruby/setup-ruby@v1
@@ -157,7 +192,7 @@ jobs:
     runs-on: macos-15
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
+    - uses: actions/setup-node@v6
       with:
         node-version-file: "./.tool-versions"
     - uses: ruby/setup-ruby@v1
@@ -190,7 +225,7 @@ jobs:
     runs-on: macos-15
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
+    - uses: actions/setup-node@v6
       with:
         node-version-file: "./.tool-versions"
     - uses: ruby/setup-ruby@v1
@@ -223,7 +258,7 @@ jobs:
     runs-on: macos-15
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
+    - uses: actions/setup-node@v6
       with:
         node-version-file: "./.tool-versions"
     - uses: ruby/setup-ruby@v1

.tool-versions

@@ -1,4 +1,4 @@
-nodejs 20.19.5
+nodejs 24.9.0
 yarn 1.22.22
 kubectl 1.21.8
 # https://github.com/actions/runner-images/blob/main/images/macos/macos-15-arm64-Readme.md#ruby

Makefile

@@ -21,26 +21,26 @@ docs:
 		--entryPoints packages/authgear-web/index.d.ts \
 		--out ./temp/docs/web \
 		--plugin typedoc-plugin-markdown \
-		--namedAnchors \
-		--entryDocument index.md
+		--useHTMLAnchors \
+		--entryFileName index.md
 	npx typedoc \
 		--options typedoc/typedoc.json \
 		--tsconfig typedoc/tsconfig.react-native.json \
 		--name @authgear/react-native \
 		--entryPoints packages/authgear-react-native/index.d.ts \
 		--out ./temp/docs/react-native \
 		--plugin typedoc-plugin-markdown \
-		--namedAnchors \
-		--entryDocument index.md
+		--useHTMLAnchors \
+		--entryFileName index.md
 	npx typedoc \
 		--options typedoc/typedoc.json \
 		--tsconfig typedoc/tsconfig.capacitor.json \
 		--name @authgear/capacitor \
 		--entryPoints packages/authgear-capacitor/index.d.ts \
 		--out ./temp/docs/capacitor \
 		--plugin typedoc-plugin-markdown \
-		--namedAnchors \
-		--entryDocument index.md
+		--useHTMLAnchors \
+		--entryFileName index.md
 	cp ./typedoc/index.md ./temp/docs/index.md
 	cp ./typedoc/web_index.md ./temp/docs/web/index.md
 	cp ./typedoc/react_native_index.md ./temp/docs/react-native/index.md

README.md

@@ -70,13 +70,13 @@ $ (cd website && yarn install --frozen-lockfile)
 
 ## Releasing
 
-- Ensure you have `node`, `npm`, and `yarn` in your `PATH`.
-- Sign in as appropriate user in npm.
-
-```sh
-# VERSION should be in format like "0.1.0"
-$ GIT_USER=<github-username> GITHUB_TOKEN=<github-token> GIT_BRANCH=master VERSION=<new-version> ./scripts/release.sh
-```
+1. Ensure you have `node`, `npm`, `yarn`, `sed`, `git` in your `PATH`.
+2. Run `npm run set-version VERSION` to set the version. VERSION should be without the `v` at the beginning, for example, `1.0.0`.
+3. Commit the change.
+4. Create a pull request for this change.
+5. Wait for merge.
+6. Run `git tag -a vVERSION -m "Release vVERSION" MERGE_COMMIT`. MERGE_COMMIT should be the commit hash of the merge commit.
+7. Push the tag to `github.com/authgear/authgear-sdk-js`.
 
 ## Known issues
 

flake.nix

@@ -26,8 +26,8 @@
         # We need to use the clang from Xcode.
         devShells.default = pkgs.mkShellNoCC {
           packages = [
-            # 20.19.5
-            pkgs.nodejs_20
+            # 24.9.0
+            pkgs.nodejs_24
             # 3.3.9
             pkgs.ruby_3_3
             # 1.22.22