Convert breaking-change-doc workflow to GitHub agentic workflow#126009
Open
ericstj wants to merge 3 commits intodotnet:mainfrom
Open
Convert breaking-change-doc workflow to GitHub agentic workflow#126009ericstj wants to merge 3 commits intodotnet:mainfrom
ericstj wants to merge 3 commits intodotnet:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates the breaking-change documentation automation from a custom PowerShell script + classic GitHub Actions workflow to a GitHub Agentic Workflow (gh-aw) backed by a dedicated breaking-change-doc skill and helper scripts.
Changes:
- Removed the legacy
eng/breakingChanges/PowerShell tooling and the previous.github/workflows/breaking-change-doc.ymlworkflow. - Added an agentic workflow source (
.md) and its compiled workflow (.lock.yml) to run the breaking-change-doc skill. - Added a new skill definition plus helper scripts for version detection and PR-comment/issue-link generation.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| eng/breakingChanges/config.ps1 | Removes legacy breaking-change-doc configuration (deleted). |
| eng/breakingChanges/breaking-change-doc.ps1 | Removes legacy all-in-one implementation (deleted). |
| eng/breakingChanges/README.md | Removes documentation for the legacy script-based workflow (deleted). |
| .github/workflows/breaking-change-doc.yml | Removes the previous GitHub Actions workflow (deleted). |
| .github/workflows/breaking-change-doc.md | Adds gh-aw workflow source that instructs the agent to run the breaking-change-doc skill. |
| .github/workflows/breaking-change-doc.lock.yml | Adds the compiled gh-aw workflow that GitHub Actions will execute. |
| .github/skills/breaking-change-doc/SKILL.md | Adds the skill definition and step-by-step process for generating docs issues/comments. |
| .github/skills/breaking-change-doc/Get-VersionInfo.ps1 | Adds git/tag-based version detection used by the skill. |
| .github/skills/breaking-change-doc/Build-IssueComment.ps1 | Adds helper to generate a PR comment containing a pre-filled docs issue link. |
| .github/aw/actions-lock.json | Adds action SHA locking metadata for gh-aw-related actions. |
| .gitattributes | Marks compiled *.lock.yml workflows as generated and uses merge=ours. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Tested skill locally in CLI. We'll add token auth later.