summaryrefslogtreecommitdiffstats
path: root/.github/workflows/jsdoc.yml
blob: 248a7cf6cd5da7ff5643342f30d6cec2d34a2c9c (plain)
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
name: GitHub pages

on:
  push:
    branches:
      - master
    paths:
      # One day we might include all htdocs folders:
      # - '**/htdocs/**'
      # Until then, follow jsdoc.conf.json:source directive
      - 'modules/luci-base/htdocs/luci-static/resources/**'
      - 'docs/**'

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    if: endsWith(github.repository, 'luci')
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Install
        run: npm install

      - name: Build
        run: npm run doc

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: ./docs/

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