doxygen.yml 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. name: doc_doxygen
  2. on:
  3. pull_request:
  4. branches:
  5. - master
  6. paths:
  7. - 'documentation/doxygen/**'
  8. - 'src/**'
  9. - 'include/**'
  10. - 'components/drivers/include/drivers/**'
  11. - 'components/dfs/dfs_v2/include/**'
  12. - 'components/dfs/dfs_v2/src/**'
  13. - 'components/finsh/**'
  14. - '.github/workflows/doxygen.yml'
  15. # Runs at 16:00 UTC (BeiJing 00:00) on the 30st of every month
  16. push:
  17. branches: [master]
  18. paths:
  19. - 'documentation/doxygen/**'
  20. - 'src/**'
  21. - 'include/**'
  22. - 'components/drivers/include/drivers/**'
  23. - 'components/dfs/dfs_v2/include/**'
  24. - 'components/dfs/dfs_v2/src/**'
  25. - 'components/finsh/**'
  26. - '.github/workflows/doxygen.yml'
  27. schedule:
  28. - cron: '0 16 30 * *'
  29. workflow_dispatch:
  30. permissions:
  31. contents: read
  32. pages: write
  33. id-token: write
  34. jobs:
  35. build:
  36. runs-on: ubuntu-22.04
  37. name: doxygen_doc generate
  38. if: github.repository_owner == 'RT-Thread'
  39. steps:
  40. - uses: actions/checkout@main
  41. with:
  42. submodules: 'recursive'
  43. - name: Install Tools
  44. shell: bash
  45. run: |
  46. sudo apt-get update
  47. sudo apt-get -qq install doxygen graphviz
  48. - name: generate doxygen html
  49. shell: bash
  50. run: |
  51. cd documentation
  52. doxygen Doxyfile
  53. cat Doxyfile
  54. - name: Upload static files as artifact
  55. id: deployment
  56. uses: actions/upload-pages-artifact@main # or specific "vX.X.X" version tag for this action
  57. with:
  58. path: documentation/html/
  59. deploy:
  60. if: github.event_name == 'push'
  61. environment:
  62. name: github-pages
  63. url: ${{ steps.deployment.outputs.page_url }}
  64. runs-on: ubuntu-22.04
  65. needs: build
  66. steps:
  67. - name: Deploy to GitHub Pages
  68. id: deployment
  69. uses: actions/deploy-pages@main