| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647 |
- name: Build and publish API docs
- on:
- push:
- # only publish v2 (main or develop); v2 is published via the Terminal.GuiV2Docs repo
- branches: [v1_release, v1_develop]
- paths:
- - docfx/**
- permissions:
- id-token: write
- pages: write
- jobs:
- # Single deploy job since we're just deploying
- deploy:
- name: Build and Deploy API docs to github-pages
- environment:
- name: github-pages
- url: ${{ steps.deployment.outputs.page_url }}
- runs-on: windows-latest
- steps:
- - name: Checkout
- uses: actions/checkout@v4
- - name: DocFX Build
- working-directory: docfx
- run: |
- dotnet tool install -g docfx
- $env:DOCFX_SOURCE_BRANCH_NAME="${{ github.ref_name }}"
- docfx metadata
- docfx build
- continue-on-error: false
- - name: Setup Pages
- uses: actions/configure-pages@v5
-
- - name: Upload artifact
- uses: actions/upload-pages-artifact@v2
- with:
- path: docfx/_site
-
- - name: Deploy to GitHub Pages
- id: deployment
- uses: actions/deploy-pages@v3
- with:
- token: ${{ secrets.GITHUB_TOKEN }}
|
