Fix GitHub pages (#191)

* Fix GitHub pages

As `peaceiris/actions-gh-pages` README describes, the `permissions / contents / write` definition is required. In other hand, without that, the step will fail. Also a jump to the version 4 is recommended. Basically because i did a test and previous version, as-is doesn't work.

* Space for testing

* switch to ubunto for documentation workflow

* build test without publish

* try again

* add tag restriction and pages back

---------

Co-authored-by: Lars Melchior <TheLartians@users.noreply.github.com>
Co-authored-by: Lars Melchior <lars.melchior@gmail.com>
This commit is contained in:
Ian Torres 2025-03-12 15:30:20 -03:00 committed by GitHub
parent 5115efe66a
commit 12cf5de1a8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -8,10 +8,14 @@ on:
env: env:
CPM_SOURCE_CACHE: ${{ github.workspace }}/cpm_modules CPM_SOURCE_CACHE: ${{ github.workspace }}/cpm_modules
permissions:
contents: write
jobs: jobs:
build: build:
name: Build and publish documentation name: Build and publish documentation
runs-on: macos-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
@ -20,18 +24,22 @@ jobs:
path: "**/cpm_modules" path: "**/cpm_modules"
key: ${{ github.workflow }}-cpm-modules-${{ hashFiles('**/CMakeLists.txt', '**/*.cmake') }} key: ${{ github.workflow }}-cpm-modules-${{ hashFiles('**/CMakeLists.txt', '**/*.cmake') }}
- name: Install dependencies - name: Install python dependencies
run: | run: |
brew install doxygen pip3 install jinja2==3.1.6 Pygments==2.19.1
pip3 install jinja2 Pygments
- name: Install Doxygen
uses: ssciwr/doxygen-install@v1
with:
version: "1.13.2"
- name: Build - name: Build
run: | run: |
cmake -Sdocumentation -Bbuild cmake -Sdocumentation -Bbuild
cmake --build build --target GenerateDocs cmake --build build --target GenerateDocs
- name: Publish - name: Publish
uses: peaceiris/actions-gh-pages@v3 uses: peaceiris/actions-gh-pages@v4
with: with:
github_token: ${{ secrets.GITHUB_TOKEN }} github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./build/doxygen/html publish_dir: ./build/doxygen/html