Skip to content

Commit

Permalink
Create api-docs-gh-pages.yml
Browse files Browse the repository at this point in the history
Workflow to build and publish API docs
  • Loading branch information
chitsaw committed Mar 15, 2024
1 parent cb3b37d commit 7f46ba0
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions .github/workflows/api-docs-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Workflow for building and deploying API docs to GitHub Pages
name: Deploy API docs to GitHub Pages

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, cancelling and skipping all in-progress/queued runs in favor of the latest queued.
concurrency:
group: "pages"
cancel-in-progress: true

jobs:
# Build job
build:
runs-on: windows-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build docfx project
run: dotnet build ./Build/docfx
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# path to docfx-generated ouptput
path: './Build/docfx/_site'

# 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

0 comments on commit 7f46ba0

Please sign in to comment.