Update Doxygen Docs #137
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: Update Doxygen Docs | |
| on: | |
| schedule: | |
| - cron: "0 * * * *" # Runs every hour at minute 0 | |
| workflow_dispatch: | |
| inputs: | |
| force_update: | |
| description: "Force the documentation update even if submodule is up to date" | |
| required: false | |
| default: "false" | |
| env: | |
| SUBMODULE_PATH: CommonLibVR | |
| permissions: | |
| contents: write | |
| jobs: | |
| update-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository including submodules | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| submodules: recursive | |
| - name: Fetch submodule latest commit | |
| run: | | |
| cd ${{ env.SUBMODULE_PATH }} | |
| git fetch origin | |
| - name: Check if submodule is up to date | |
| id: check_submodule | |
| run: | | |
| cd ${{ env.SUBMODULE_PATH }} | |
| LOCAL_COMMIT=$(git rev-parse HEAD) | |
| REMOTE_BRANCH=$(git rev-parse --abbrev-ref origin/HEAD | sed 's@^origin/@@') | |
| REMOTE_COMMIT=$(git rev-parse origin/${REMOTE_BRANCH}) | |
| echo "LOCAL_COMMIT=${LOCAL_COMMIT}" | |
| echo "REMOTE_COMMIT=${REMOTE_COMMIT}" | |
| if [ "$LOCAL_COMMIT" = "$REMOTE_COMMIT" ]; then | |
| echo "Submodule is up to date." | |
| echo "UPDATED=false" >> $GITHUB_OUTPUT | |
| else | |
| echo "Submodule is not up to date." | |
| echo "UPDATED=true" >> $GITHUB_OUTPUT | |
| fi | |
| - name: Determine if we should proceed with the update | |
| id: should_proceed | |
| run: | | |
| if [ "${{ steps.check_submodule.outputs.UPDATED }}" == "true" ] || [ "${{ github.event.inputs.force_update }}" == "true" ]; then | |
| echo "PROCEED=true" >> $GITHUB_OUTPUT | |
| else | |
| echo "PROCEED=false" >> $GITHUB_OUTPUT | |
| fi | |
| - name: Update submodule | |
| if: steps.should_proceed.outputs.PROCEED == 'true' | |
| run: | | |
| git submodule update --remote ${{ env.SUBMODULE_PATH }} | |
| - name: Get submodule latest commit SHA | |
| if: steps.should_proceed.outputs.PROCEED == 'true' | |
| id: get_submodule_sha | |
| run: | | |
| SUBMODULE_SHA=$(git submodule status ${{ env.SUBMODULE_PATH }} | awk '{print $1}' | sed 's/^-//;s/^+//;s/^ //') | |
| SUBMODULE_SHA_SHORT=$(echo $SUBMODULE_SHA | cut -c1-7) | |
| echo "SUBMODULE_SHA=${SUBMODULE_SHA_SHORT}" >> $GITHUB_OUTPUT | |
| - name: Update README.md placeholders | |
| if: steps.should_proceed.outputs.PROCEED == 'true' | |
| run: | | |
| TIMESTAMP=$(date -u +"%Y-%m-%d %H:%M:%S UTC") | |
| SUBMODULE_SHA=${{ steps.get_submodule_sha.outputs.SUBMODULE_SHA }} | |
| sed -i "s/TIMESTAMP_PLACEHOLDER/${TIMESTAMP}/g" README.md | |
| sed -i "s/COMMIT_SHA_PLACEHOLDER/${SUBMODULE_SHA}/g" README.md | |
| - name: Install Doxygen | |
| if: steps.should_proceed.outputs.PROCEED == 'true' | |
| run: sudo apt-get install -y doxygen | |
| - name: Run Doxygen | |
| if: steps.should_proceed.outputs.PROCEED == 'true' | |
| run: doxygen Doxyfile | |
| - name: Commit and push changes | |
| if: steps.should_proceed.outputs.PROCEED == 'true' && success() | |
| run: | | |
| git config user.name "GitHub Actions" | |
| git config user.email "[email protected]" | |
| git add ${{ env.SUBMODULE_PATH }} docs/ | |
| git commit -m "Updated docs to ${{ steps.get_submodule_sha.outputs.SUBMODULE_SHA }}" | |
| git push |