Skip to content

Add a documentation site (#120) #5

Add a documentation site (#120)

Add a documentation site (#120) #5

Workflow file for this run

name: GitHub Pages
on:
push:
branches:
- main
# 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-docs:
name: Build Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup .NET
uses: actions/setup-dotnet@v4
with:
dotnet-version: 9.0.x
- name: Install docfX
run: dotnet tool update -g docfx
- name: Build documentation
run: docfx docfx.json
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'artifacts/_site'
publish-docs:
name: Publish Documentation
needs: build-docs
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
actions: read
pages: write
id-token: write
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4