Github files #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: Document with Doxygen | |
# Documents the BURT_can library with Doxygen. | |
# Publishes the result to a separate branch, `documentation`, under | |
# `docs/`, which can be published through GitHub Pages. | |
on: | |
push: | |
branches: [ main ] | |
jobs: | |
documentation: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v2 | |
with: | |
fetch-depth: 0 | |
submodules: recursive | |
- name: Remove previous docs | |
run: | | |
git config --local user.name "github-actions[bot]" | |
git branch --all | |
git switch --track origin/documentation | |
git merge origin/main | |
rm -rf docs | |
git stage docs | |
git commit -m "Removed documentation" -m "Will generate new docs" | |
- name: Run Doxygen | |
uses: mattnotmitt/[email protected] | |
with: | |
doxyfile-path: libraries/Doxyfile | |
- name: Commit and push files | |
run: | | |
git status | |
git stage --force . | |
git commit -a -m "Generated documentation" | |
git push |