doxygen.yml 1.9 KB

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