Publish Doxygen documentation #157
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
# Nom de notre workflow | |
name: Publish Doxygen documentation | |
# Événements sur lesquels il doit être déclenché | |
on: | |
push: # <- Déclenché lorsque l'on pousse du code... | |
branches: | |
- develop # <- ... mais seulement sur la branche "develop" | |
paths: | |
-pvsneslib/** | |
workflow_dispatch: | |
jobs: | |
# Notre job | |
build-and-deploy: | |
runs-on: ubuntu-latest | |
# Tâches à effectuer, comme expliquées ci-dessus | |
steps: | |
# 1. On récupère le contenu du dépôt | |
- name: "Checkout" | |
uses: actions/checkout@v3 | |
with: | |
ref: develop | |
persist-credentials: false | |
# 2. installation des dépendances et génération de la doc | |
- name: Install Doxygen | |
run: | | |
sudo apt-get install doxygen -y | |
shell: bash | |
- name: "Build Doxygen Doc" | |
run: | | |
cd pvsneslib | |
export PVSNESLIB_HOME=`pwd` | |
make docs | |
shell: bash | |
# 3. Déploiement sur les Github Pages | |
- name: "Deploy Github Pages" | |
uses: JamesIves/github-pages-deploy-action@v4 | |
with: | |
branch: gh-pages # <- Branche sur laquelle seront commités les fichiers | |
folder: pvsneslib/docs/html/ # <- Dossier contenant notre documentation générée |