diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index b06f4290949..2b57a00bdf1 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -11,18 +11,35 @@ on: - 'components/dfs/dfs_v2/include/**' - 'components/dfs/dfs_v2/src/**' - 'components/finsh/**' + - '.github/workflows/doxygen.yml' # Runs at 16:00 UTC (BeiJing 00:00) on the 30st of every month + push: + branches: [master] + paths: + - 'documentation/doxygen/**' + - 'src/**' + - 'include/**' + - 'components/drivers/include/drivers/**' + - 'components/dfs/dfs_v2/include/**' + - 'components/dfs/dfs_v2/src/**' + - 'components/finsh/**' + - '.github/workflows/doxygen.yml' schedule: - cron: '0 16 30 * *' workflow_dispatch: - + +permissions: + contents: read + pages: write + id-token: write + jobs: build: runs-on: ubuntu-22.04 name: doxygen_doc generate if: github.repository_owner == 'RT-Thread' steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@main with: submodules: 'recursive' - name: Install Tools @@ -30,9 +47,27 @@ jobs: run: | sudo apt-get update sudo apt-get -qq install doxygen graphviz - - name: generat doxygen html + - name: generate doxygen html shell: bash run: | cd documentation/doxygen doxygen Doxyfile cat Doxyfile + + - name: Upload static files as artifact + id: deployment + uses: actions/upload-pages-artifact@main # or specific "vX.X.X" version tag for this action + with: + path: documentation/doxygen/html/ + + deploy: + if: github.event_name == 'push' + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-22.04 + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@main