Add Exercise 6.6 #14
This file contains hidden or 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: Documentation | |
| # Controls when the workflow will run | |
| on: | |
| # Triggers the workflow on push or pull request events but only for the master branch | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| # This workflow contains a single job called "build" | |
| build_documentation: | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-22.04 | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - uses: actions/checkout@v4 | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update -qq | |
| sudo apt-get install -y -qq doxygen graphviz plantuml | |
| pip install sphinx-rtd-theme | |
| pip install sphinxcontrib-plantuml | |
| pip install sphinx-mdinclude | |
| pip install breathe | |
| pip install exhale | |
| pip install myst-parser | |
| pip install sphinx_copybutton | |
| - name: Build documentation | |
| run: | | |
| cd ./workshop | |
| make html | |
| cd ../ | |
| - name: Create commit | |
| run: | | |
| # Clone this repository's gh-pages branch so commits fast-forward correctly | |
| git clone https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git --branch gh-pages --single-branch gh-pages | |
| mkdir -p gh-pages/ | |
| cp -r ./workshop/build/html/* gh-pages/ | |
| cd gh-pages | |
| git config --local user.email "[email protected]" | |
| git config --local user.name "GitHub Action" | |
| git add . | |
| git commit -m "Update documentation" -a || true | |
| - name: Push changes | |
| uses: ad-m/github-push-action@master | |
| with: | |
| branch: gh-pages | |
| directory: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} |