Merge pull request #39 from dimitrovs/next

Add GitHub Actions workflow for publishing package on version tags

Author: dimitrovs

.claude/settings.json

@@ -4,7 +4,13 @@
       "Bash(npm run test:coverage)",
       "Bash(pnpm --version)",
       "Bash(pnpm install)",
-      "Bash(pnpm test)"
+      "Bash(pnpm test)",
+      "Bash(pnpm info typedoc versions --json)",
+      "Bash(pnpm info typedoc@0.28 version)",
+      "WebFetch(domain:github.com)",
+      "Bash(pnpm add -D typedoc@^0.28.0)",
+      "Bash(pnpm run build)",
+      "Bash(npx typedoc)"
     ]
   }
 }

.github/workflows/ci.yml

@@ -16,19 +16,3 @@ jobs:
           cache: 'pnpm'
       - run: pnpm install
       - run: pnpm run dist
-  release:
-    needs: test
-    if: github.ref == 'refs/heads/master' && github.event_name == 'push'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 'lts/*'
-          cache: 'pnpm'
-      - run: pnpm install
-      - run: npx semantic-release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/doc.workflow.yml

@@ -3,11 +3,13 @@ on:
   push:
     branches:
       - master
+permissions:
+  contents: read
+  pages: write
+  id-token: write
 jobs:
   build:
-    name: Publishing UHST Server Node Docs to GitHub pages
-    env:
-      my_secret: ${{secrets.COMMIT_SECRET}}
+    name: Build docs
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -16,21 +18,19 @@ jobs:
         with:
           node-version: '20'
           cache: 'pnpm'
-      - run: |
-          pnpm install
-          pnpm run dist
-          cd docs
-          touch .nojekyll
-          git init
-          # type configurations: your user.email and user.name followed lines
-          # git config --global user.email your_email
-          # git config --global user.name your_name
-          git config --global user.email ${{secrets.USER_EMAIL}}
-          git config --global user.name ${{secrets.USER_NAME}}
-          git status
-          # change this remote url for examle your remote url is then the following:
-          git remote add origin https://${{secrets.COMMIT_SECRET}}@github.com/uhst/uhst-server-node.git
-          git checkout -b gh-pages
-          git add --all
-          git commit -m "docs"
-          git push origin gh-pages -f
+      - run: pnpm install
+      - run: pnpm run dist
+      - run: touch docs/.nojekyll
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/publish.yml

@@ -0,0 +1,40 @@
+name: Publish Package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  id-token: write
+  contents: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+          registry-url: 'https://registry.npmjs.org'
+
+      - run: pnpm install
+
+      - run: pnpm run dist
+
+      - name: Set package version from tag
+        run: npm version "${GITHUB_REF_NAME#v}" --no-git-tag-version --allow-same-version
+        working-directory: dist
+
+      - name: Publish to npm
+        run: pnpm publish --provenance --access public --no-git-checks
+        working-directory: dist
+
+      - name: Create GitHub Release
+        run: gh release create "$GITHUB_REF_NAME" --generate-notes
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package.json

@@ -16,8 +16,7 @@
     "test": "pnpm run clean && pnpm run build && mocha dist/test/**/*.test.js --exit",
     "test:coverage": "nyc mocha test/**/*.test.ts --require ts-node/register --exit",
     "test-watch": "pnpm run clean && tsc-watch --onSuccess \"mocha dist/test/**/*.test.js\"",
-    "dist": "pnpm test && copyfiles bin/* package.json README.md LICENSE dist && typedoc",
-    "semantic-release": "semantic-release"
+    "dist": "pnpm test && copyfiles bin/* package.json README.md LICENSE dist && typedoc"
   },
   "repository": {
     "type": "git",
@@ -61,23 +60,16 @@
     "nodemon": "^3.1.0",
     "nyc": "^17.1.0",
     "proxyquire": "^2.1.3",
-    "semantic-release": "^24.0.0",
+
     "sinon": "^21.0.1",
     "supertest": "^7.0.0",
     "ts-node": "^10.9.0",
     "tsc-watch": "^6.2.0",
-    "typedoc": "^0.27.0",
+    "typedoc": "^0.28.17",
     "typescript": "^5.7.0"
   },
   "engines": {
     "node": ">=18.0.0"
   },
-  "packageManager": "pnpm@10.18.3",
-  "release": {
-    "pkgRoot": "dist",
-    "assets": [
-      "dist/*.zip",
-      "dist/*.tar.gz"
-    ]
-  }
+  "packageManager": "pnpm@10.18.3"
 }