Skip to content

Convert release pipelines (#621) #42

Convert release pipelines (#621)

Convert release pipelines (#621) #42

# Simple workflow for deploying static content to GitHub Pages
name: Deploy API Documentation to GitHub Pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# 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:
# 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: Setup Pages
uses: actions/configure-pages@v3
# Install .NET and DocFx
- name: Setup .NET Core
uses: actions/setup-dotnet@v3
with:
dotnet-version: '7.0.x'
- name: Install docfx
run: dotnet tool update -g docfx
# Build the API docs
- name: Run DocFx
run: docfx docfx_project/docfx.json
# Upload constructed site
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: 'docfx_project/_site'
# deploy to GitHub Pages
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2