This repository has been archived by the owner on Jan 26, 2025. It is now read-only.
Update Docs #1418
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 Docs | |
on: | |
push: | |
branches: | |
- main | |
schedule: | |
- cron: '0 * * * *' | |
workflow_dispatch: | |
jobs: | |
update_docs: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout Repository | |
uses: actions/checkout@v3.4.0 | |
- name: Set up Doxygen | |
run: sudo apt-get install doxygen | |
- name: Generate Doxygen Documentation | |
run: | | |
doxygen docs/Doxyfile | |
- name: Set up Git Credentials | |
run: | | |
git config --global user.name 'GitHub Actions' | |
git config --global user.email 'actions@github.com' | |
- name: Commit & Push Documentation | |
run: | | |
git diff > diff.txt | |
if [ -s diff.txt ]; then | |
COMMITTER_NAME=$(git log -1 --pretty=format:'%an') | |
COMMITTER_EMAIL=$(git log -1 --pretty=format:'%ae') | |
COMMITTER_MESSAGE=$(git log -1 --pretty=format:'%s') | |
git add docs/ | |
git commit -m "[Docs Update] - $COMMITTER_MESSAGE" | |
git commit --amend --author="$COMMITTER_NAME <$COMMITTER_EMAIL>" -m "[Docs Update] - $COMMITTER_MESSAGE" | |
git push --force origin main | |
fi |