Merge pull request #18 from ineka-dev/fix/documentation

Working documentation generation and deployment

Author: ColinEspinas

.github/workflows/docs.yml

@@ -4,61 +4,71 @@ on:
     branches:
       - main
 jobs:
-# build-and-test:
-#   name: Build and test project before generating documentation
-#   runs-on: ubuntu-latest
-#   steps:
-#     - uses: actions/checkout@v2
-#     - name: Use Node.js LTS
-#       uses: actions/setup-node@v2
-#       with:
-#         node-version: lts/*
-#     - name: Cache node modules
-#       uses: actions/cache@v2
-#       env:
-#         cache-name: cache-node-modules
-#       with:
-#         path: ~/.npm
-#         key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
-#         restore-keys: |
-#           ${{ runner.os }}-build-${{ env.cache-name }}-
-#           ${{ runner.os }}-build-
-#           ${{ runner.os }}-
-#     - name: Install dependencies
-#       run: npm ci --prefer-offline
-#     - name: Build project
-#       run: npm run build
-#     - name: Lint project code
-#       run: npm run lint
+  build-and-test:
+    name: Build and lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
 
-# build-docs:
-#   name: Build and deploy documentation
-#   runs-on: ubuntu-latest
-#   needs: [build-and-test]
-#   steps:
-#     - uses: actions/checkout@v2
-#     - name: Use Node.js LTS
-#       uses: actions/setup-node@v2
-#       with:
-#         node-version: lts/*
-#     - name: Cache node modules
-#       uses: actions/cache@v2
-#       env:
-#         cache-name: cache-node-modules
-#       with:
-#         path: ~/.npm
-#         key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
-#         restore-keys: |
-#           ${{ runner.os }}-build-${{ env.cache-name }}-
-#           ${{ runner.os }}-build-
-#           ${{ runner.os }}-
-#     - name: Install dependencies
-#       run: npm ci --prefer-offline
-#     - name: Generate documentation
-#       run: npm run docs
-#     - name: Deploy to GitHub Pages
-#       uses: peaceiris/actions-gh-pages@v3
-#       with:
-#         github_token: ${{ secrets.GITHUB_TOKEN }}
-#         publish_dir: ./docs
-#         publish_branch: docs
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Use Node.js LTS
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build
+        run: pnpm build
+
+      - name: Lint
+        run: pnpm lint
+
+  build-docs:
+    name: Build and deploy documentation
+    runs-on: ubuntu-latest
+    needs: [build-and-test]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Use Node.js LTS
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Generate documentation
+        run: pnpm docs:generate
+
+      - name: Upload GitHub Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs
+
+  deploy-docs:
+    needs: build-docs
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package.json

@@ -18,7 +18,8 @@
     "preinstall": "npx only-allow pnpm",
     "dev": "rollup -cw",
     "build": "rollup --config rollup.config.ts --configPlugin typescript --environment NODE_ENV:production",
-    "docs": "typedoc ./src",
+    "docs:generate": "typedoc",
+    "docs:serve": "serve docs",
     "lint": "eslint . --flag unstable_ts_config",
     "lint:fix": "eslint . --fix --flag unstable_ts_config",
     "release:publish": "changeset publish",
@@ -38,6 +39,7 @@
     "rollup": "^4.21.0",
     "rollup-plugin-dts": "^6.1.1",
     "rollup-plugin-esbuild": "^6.1.1",
+    "serve": "^14.2.3",
     "tslib": "^2.6.3",
     "typedoc": "^0.26.6",
     "typescript": "~5.5.4"