Skip to content

Documentation (#79)

Documentation (#79) #3

# This is a basic workflow to help you get started with Actions
name: Doxygen Action main
# 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 ]
jobs:
build:
runs-on: ubuntu-latest
# 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
- run: echo "event= ${{ github.event_name }}"
- run: echo "os= ${{ runner.os }}"
- run: echo "repository= ${{ github.repository }}"
- run: echo "branch= ${{ github.ref }}"
- 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 }}/main/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