Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doxygen update & cleanup #383

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
74 changes: 74 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: publish-doxygen

on:
workflow_dispatch: # Allows manual trigger of the workflow
push:
branches:
- 'master' # Trigger on push to the 'master' branch
- 'latest' # Trigger on push to the 'latest' branch
schedule:
- cron: '0 0 * * *' # Runs daily at midnight UTC

env:
# Used to find the download link:
# https://www.doxygen.nl/files/doxygen-X.XX.X.linux.bin.tar.gz
# Version # updated on: 2024.01.06
DOXYGEN_VERSION: 1.13.1

jobs:
cleanup:
runs-on: ubuntu-latest
permissions: write-all

steps:
# Step to cleanup previous deployments to prevent stacking of old deployments
- name: 🗑 Cleanup deployments
uses: strumwolf/delete-deployment-environment@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
environment: github-pages
onlyRemoveDeployments: true

build:
runs-on: ubuntu-latest
steps:
# Step to checkout the SGDK repository
- name: Checkout repository
uses: actions/checkout@v3
with:
path: SGDK

# Step to install Graphviz for generating code flow charts with Doxygen
- name: Install Graphviz
run: sudo apt-get install graphviz -y

# Step to download and install Doxygen
- name: Download and Install Doxygen
run: |
wget https://www.doxygen.nl/files/doxygen-${{ env.DOXYGEN_VERSION }}.linux.bin.tar.gz -O - | tar -xz
mv doxygen* ~/doxygen

# Step to generate Doxygen HTML documentation
- name: Generate Doxygen files
run: ~/doxygen/bin/doxygen ./SGDK/doc/doxyconfig

# Step to upload the generated files as an artifact
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: /tmp/doxygen/html

deploy:
needs: build # Ensures that the deploy job runs after the build job completes
permissions:
pages: write # Grant permission to write to GitHub Pages
id-token: write # Grant permission for id-token usage
environment:
name: github-pages # The environment name for deployment
url: ${{ steps.deployment.outputs.page_url }} # URL of the deployed pages
runs-on: ubuntu-latest
steps:
# Step to deploy the generated Doxygen files to GitHub Pages
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
1,165 changes: 735 additions & 430 deletions doc/doxyfile.unix → doc/doxyconfig

Large diffs are not rendered by default.

Loading