.github/workflows/jsdoc.yml

   1 name: GitHub pages
   2
   3 on:
   4   push:
   5     branches:
   6       - master
   7     paths:
   8       # One day we might include all htdocs folders:
   9       # - '**/htdocs/**'
  10       # Until then, follow jsdoc.conf.json:source directive
  11       - 'modules/luci-base/htdocs/luci-static/resources/**'
  12       - 'docs/**'
  13
  14 jobs:
  15   deploy:
  16     if: github.repository == 'openwrt/luci'
  17     runs-on: ubuntu-latest
  18     steps:
  19       - name: Checkout code
  20         uses: actions/checkout@v4
  21
  22       - name: Install
  23         run: npm install
  24
  25       - name: Build
  26         run: npm run doc
  27
  28       - name: Archive docs as artifact
  29         uses: actions/upload-artifact@v4
  30         with:
  31           name: docs
  32           path: ./docs/
  33
  34       - name: Deploy
  35         uses: peaceiris/actions-gh-pages@v3
  36         with:
  37           github_token: ${{ secrets.GITHUB_TOKEN }}
  38           publish_dir: ./docs/
  39           enable_jekyll: true