node-pg-sequelize-boilerplate/.github/workflows/gh-pages-deploy.yaml at main · TheCodersStudio/node-pg-sequelize-boilerplate · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# Workflow to deploy static esdoc documentation to GitHub Pages
name: Deploy ESDoc Documentation to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: [main]

  # # Allows you to run this workflow manually from the Actions tab
  # workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v3

      - name: Install 🔧
        run: npm install

      - name: Generate ESDoc 📖
        run: npm run esdoc

      - name: Setup Pages ⚙️
        uses: actions/configure-pages@v3

      - name: Upload artifact 📁
        uses: actions/upload-pages-artifact@v1
        with:
          # Upload doc directory
          path: './doc'

      - name: Deploy to GitHub Pages 🚀
        id: deployment
        uses: actions/deploy-pages@v2