Skip to content

GitHub Pages

GitHub Pages #21

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: GitHub Pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["production"]
# 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
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CMAKE_BUILD_PARALLEL_LEVEL: 3
CMAKE_INSTALL_PARALLEL_LEVEL: 3
VCPKG_MAX_CONCURRENCY: 3
VCPKG_ROOT: ${{ github.workspace }}/vcpkg
STONEYVCV_VERSION_MAJOR: ${{ vars.STONEYVCV_VERSION_MAJOR }}
STONEYVCV_VERSION_MINOR: ${{ vars.STONEYVCV_VERSION_MINOR }}
STONEYVCV_VERSION_PATCH: ${{ vars.STONEYVCV_VERSION_PATCH }}
STONEYVCV_VERSION: ${{ vars.STONEYVCV_VERSION_MAJOR }}.${{ vars.STONEYVCV_VERSION_MINOR }}.${{ vars.STONEYVCV_VERSION_PATCH }}
jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install VCV's Linux Deps
run: |
sudo apt-get update && sudo apt install make doxygen ninja-build cmake graphviz
- name: vcpkg install
uses: johnwason/vcpkg-action@v6
with:
# vcpkg triplet to use
triplet: x64-linux
# GitHub token to authenticate API requests. Recommended to use github.token
token: ${{ github.token }}
# Directory containing vcpkg.json manifest file. Cannot be used with pkgs.
manifest-dir: ${{ github.workspace }}
# Use vcpkg built-in GitHub binary caching. If not specified, will use the dry-run based file cache.
github-binarycache: true
- name: Configure StoneyVCV
working-directory: ${{ github.workspace }}
run: cmake --preset x64-linux-release --fresh
- name: Make Doxygen
working-directory: ${{ github.workspace }}
run: doxygen ${{ github.workspace }}/docs/Doxyfile
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload HTML
path: '${{ github.workspace }}/build/docs/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4