mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
46 lines
1.1 KiB
YAML
46 lines
1.1 KiB
YAML
name: Build and publish API docs
|
|
|
|
on:
|
|
push:
|
|
# only publish v2 (main or develop); v2 is published via the Terminal.GuiV2Docs repo
|
|
branches: [main, develop]
|
|
|
|
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@v3
|
|
|
|
- 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@v3
|
|
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v2
|
|
with:
|
|
path: docfx/_site
|
|
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v2
|
|
with:
|
|
token: ${{ secrets.GITHUB_TOKEN }}
|