Add Doxygen Github Action to generate docs #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Build and Deploy Doxygen Documentation | ||
| on: [workflow_call, pull_request] | ||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| defaults: | ||
| run: | ||
| working-directory: ./doc | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
| # - name: Cache Doxygen Installation | ||
| # uses: actions/cache@v3 | ||
| # id: cache-doxygen-install | ||
| # with: | ||
| # path: /usr/local/bin/doxygen | ||
| # key: doxygen-install-cache | ||
| - name: Install Doxygen | ||
| # if: steps.cache-doxygen-install.outputs.cache-hit != 'true' | ||
| run: | | ||
| sudo apt-get install -y doxygen | ||
| which doxygen | ||
| - name: Run doxygen | ||
| run: doxygen Doxyfile | ||
| - name: Cache Doxygen Output | ||
| uses: actions/cache@v3 | ||
| id: cache-doxygen | ||
| with: | ||
| path: | | ||
| doxygenOut/html | ||
| doxygenOut/xml | ||
| key: ${{ github.ref }}-doxygen-output | ||
| - name: Print Doxygen Warning Log | ||
| run: cat DoxygenWarningLog.txt | ||
| - name: Zip doxygen documentation | ||
| run: | | ||
| mv doxygenOut/html doxygen_docs | ||
| zip -r doxygen_docs.zip doxygen_docs | ||
| - name: Upload doxygen_docs | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: doxygen_docs | ||
| path: ./doc/doxygen_docs.zip | ||
