Skip to content

Add docs to breaking change workflow. #9

Add docs to breaking change workflow.

Add docs to breaking change workflow. #9

name: Breaking Change Documentation
on:
pull_request_target:
types: [labeled]
permissions:
contents: read
pull-requests: write
models: read
jobs:
generate-breaking-change-doc:
if: contains(github.event.label.name, 'needs-breaking-change-doc-created') && github.repository_owner == 'dotnet'
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0 # Need full history for version detection
- name: Verify PowerShell
run: |
pwsh --version
- name: Verify GitHub CLI
run: |
gh --version
- name: Install GitHub Models extension
run: |
gh extension install github/gh-models --force
env:
GH_TOKEN: ${{ github.token }}
- name: Install GitHub Copilot CLI
run: |
npm install -g @github/copilot
copilot --version
- name: Fetch latest tags
run: |
git fetch --tags --force
- name: Run breaking change documentation script
shell: pwsh
working-directory: eng/breakingChanges
run: ./breaking-change-doc.ps1 -PrNumber ${{ github.event.pull_request.number }} -Comment
env:
GH_TOKEN: ${{ github.token }}
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: breaking-change-doc-artifacts-${{ github.event.pull_request.number }}
path: artifacts/docs/breakingChanges/
retention-days: 7