Skip to content

Commit

Permalink
update from github template (#55)
Browse files Browse the repository at this point in the history
  • Loading branch information
gillins authored Mar 1, 2024
1 parent 1dff4a6 commit af8e8b5
Showing 1 changed file with 33 additions and 25 deletions.
58 changes: 33 additions & 25 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,38 +1,46 @@
name: cppdocs
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

# see https://pdoc.dev/docs/pdoc.html#deploying-to-github-pages
# and https://github.com/satu0king/Github-Documentation-With-Doxygen/blob/master/main.yml

# build the documentation whenever there are new commits on main
on:
# Runs on pushes targeting the default branch
push:
branches:
- main
# Alternative: only build for tags.
# tags:
# - '*'
branches: ["master"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# security: restrict permissions for CI jobs.
# 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 the documentation and upload the static HTML files as an artifact.
build:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Doxygen Action
uses: mattnotmitt/[email protected]

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
# If you're changing the branch from main,
# also change the `main` in `refs/heads/main`
# below accordingly.
if: github.ref == 'refs/heads/main'
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs

# Upload entire repository
path: '.'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit af8e8b5

Please sign in to comment.