doxygen.yml 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  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. concurrency:
  35. group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  36. cancel-in-progress: true
  37. permissions:
  38. contents: read
  39. pages: write
  40. id-token: write
  41. jobs:
  42. build:
  43. runs-on: ubuntu-22.04
  44. name: doxygen_doc generate
  45. if: github.repository_owner == 'RT-Thread'
  46. steps:
  47. - uses: actions/checkout@main
  48. with:
  49. submodules: 'recursive'
  50. - name: Install Tools
  51. shell: bash
  52. run: |
  53. sudo apt-get update
  54. sudo apt-get -qq install doxygen graphviz
  55. - name: generate doxygen html
  56. shell: bash
  57. run: |
  58. cd documentation
  59. doxygen Doxyfile.1.9.1
  60. cat Doxyfile.1.9.1
  61. - name: Upload static files as artifact
  62. id: deployment
  63. uses: actions/upload-pages-artifact@main # or specific "vX.X.X" version tag for this action
  64. with:
  65. path: documentation/html/
  66. deploy:
  67. if: github.event_name == 'push'
  68. environment:
  69. name: github-pages
  70. url: ${{ steps.deployment.outputs.page_url }}
  71. runs-on: ubuntu-22.04
  72. needs: build
  73. steps:
  74. - name: Deploy to GitHub Pages
  75. id: deployment
  76. uses: actions/deploy-pages@main