jsdoc.yml 878 B

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