1
0
Fork 0
mirror of https://github.com/TheLartians/ModernCppStarter.git synced 2025-08-30 05:31:13 +02:00
ModernCppStarter/.github/workflows/documentation.yaml
Ian Torres 12cf5de1a8
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>
2025-03-12 19:30:20 +01:00

45 lines
999 B
YAML

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