Documentation #3
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
| # This is a basic workflow to help you get started with Actions | ||
| name: Doxygen Action | ||
| # Controls when the action will run. Triggers the workflow on push or pull request | ||
| # events but only for the master branch | ||
| on: | ||
| push: | ||
| branches: [ main, 2024 ] | ||
| jobs: | ||
| status: | ||
| # The type of runner that the job will run on | ||
| runs-on: ubuntu-latest | ||
| # Steps represent a sequence of tasks that will be executed as part of the job | ||
| steps: | ||
| - run: echo "▬▶︎ event: ${{ github.event_name }}, os: ${{ runner.os }}." | ||
| - run: echo "▬▶︎ repository: ${{ github.repository }}, branch: ${{ github.ref }}." | ||
| build: | ||
| needs: status | ||
| # Steps represent a sequence of tasks that will be executed as part of the job | ||
| steps: | ||
| - run: echo "▬▶︎ event: ${{ github.event_name }}, os: ${{ runner.os }}." | ||
| - run: echo "▬▶︎ repository: ${{ github.repository }}, branch: ${{ github.ref }}." | ||
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | ||
| - name: Check out repository code | ||
| uses: actions/checkout@v4 | ||
| - name: Doxygen Action | ||
| uses: mattnotmitt/[email protected] | ||
| with: | ||
| working-directory: '.' | ||
| doxyfile-path: 'documentation/DoxyFile' | ||
| # Deploy job, see https://github.com/actions/deploy-pages | ||
| deploy: | ||
| # Add a dependency to the build job | ||
| needs: build | ||
| # Grant GITHUB_TOKEN the permissions required to make a Pages deployment | ||
| permissions: | ||
| pages: write # to deploy to Pages | ||
| id-token: write # to verify the deployment originates from an appropriate source | ||
| # Deploy to the github-pages environment | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }}/C | ||
| # Specify runner + deployment step | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action | ||
