mirror of
https://github.com/github/spec-kit.git
synced 2026-07-03 12:28:06 +08:00
cdbea09e1a
Add repository check to build and deploy jobs so they skip with success on forks, avoiding failed Pages deployments for contributors.
71 lines
1.7 KiB
YAML
71 lines
1.7 KiB
YAML
# Build and deploy DocFX documentation to GitHub Pages
|
|
name: Deploy Documentation to Pages
|
|
|
|
on:
|
|
# Runs on pushes targeting the default branch
|
|
push:
|
|
branches: ["main"]
|
|
paths:
|
|
- 'docs/**'
|
|
|
|
# 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:
|
|
# Build job
|
|
build:
|
|
if: github.repository == 'github/spec-kit'
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v6
|
|
with:
|
|
fetch-depth: 0 # Fetch all history for git info
|
|
|
|
- name: Setup .NET
|
|
uses: actions/setup-dotnet@v4
|
|
with:
|
|
dotnet-version: '8.x'
|
|
|
|
- name: Setup DocFX
|
|
run: dotnet tool install -g docfx
|
|
|
|
- name: Build with DocFX
|
|
run: |
|
|
cd docs
|
|
docfx docfx.json
|
|
|
|
- name: Setup Pages
|
|
uses: actions/configure-pages@v6
|
|
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: 'docs/_site'
|
|
|
|
# Deploy job
|
|
deploy:
|
|
if: github.repository == 'github/spec-kit'
|
|
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@v5
|
|
|