Page workflow action #29

gionatamettifogo · gionatamettifogo · commit e04b975e0226 · 2023-11-16T12:00:30.000+01:00
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -1,31 +1,35 @@
-name: Publish TypeDoc to GitHub Pages
+name: 'Typedoc pages'
 
 on:
   push:
-    branches:
-      - main
+    branches: [main]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
 
 jobs:
-  build-and-deploy:
+  build:
     runs-on: ubuntu-latest
-
     steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v2
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+      - run: npm install
+      # Generate TypeDoc documentation
+      - run: npm run typedoc
+      # https://github.com/actions/upload-pages-artifact
+      - uses: actions/upload-pages-artifact@v2
         with:
-          node-version: '18'
-
-      - name: Install Dependencies
-        run: npm install
-
-      - name: Generate TypeDoc Documentation
-        run: npm run typedoc
-
+          path: ./docs
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    steps:
       - name: Deploy to GitHub Pages
+        id: deployment
+        # https://github.com/actions/deploy-pages
         uses: actions/deploy-pages@v2
-        with:
-          branch: gh-pages # Pushes to the gh-pages branch
-          folder: docs # Replace with the folder where TypeDoc outputs the files
