1
0
mirror of https://github.com/SMFSW/cI2C synced 2025-05-15 17:03:40 +02:00

Create jekyll-gh-pages.yml

Setting up jekyll env to generate documentation with doxygen and push to gh-pages
This commit is contained in:
SMFSW 2025-04-30 23:25:06 +02:00 committed by GitHub
parent d31cca271e
commit 3176bde372
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

53
.github/workflows/jekyll-gh-pages.yml vendored Normal file
View File

@ -0,0 +1,53 @@
# Sample workflow for building and deploying a Doxygen site to GitHub Pages
name: Deploy Doxygen docs to gh-pages branch
on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Run Doxygen
uses: mattnotmitt/doxygen-action@edge
with:
# working-directory: '/doxygen'
doxyfile-path: 'Doxyfile.auto'
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: html
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4