doxygen.yml 2.0 KB

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