auto-ros/.github/workflows/docs.yml at master · tue-robotics/auto-ros · 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
49
50
51
52
53
54
55
name: Docs Deployment

on:
  workflow_dispatch:
    inputs:
      deploy:
        description: "Deploy to GitHub Pages"
        required: true
        type: boolean
        default: false

  workflow_call:
    inputs:
      deploy:
        description: "Deploy to GitHub Pages"
        required: true
        type: boolean
        default: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-node@v6
        with:
          cache: npm
          node-version: 24
      - name: Install
        run: npm ci
      - name: Generate docs
        run: npm run doc
      - name: Upload static files as artifact
        id: deployment
        uses: actions/upload-pages-artifact@v4
        with:
          path: doc


  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    permissions:
      actions: read # to read the artifact from the previous job
      # pages and id-token required to deploy to GitHub Pages
      pages: write
      id-token: write
    if: inputs.deploy
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5