-
Couldn't load subscription status.
- Fork 5.2k
Breaking change doc tool #120987
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Breaking change doc tool #120987
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces an automated workflow for creating breaking change documentation. When a PR is labeled needs-breaking-change-doc-created, a PowerShell script analyzes the PR details and uses an LLM to generate documentation content. The generated content is then encoded into a clickable GitHub issue creation link, which is posted as a comment on the PR.
Key Changes
- PowerShell script that collects PR data, analyzes it with LLM, and generates breaking change documentation
- GitHub Actions workflow that triggers on label addition to run the automation
- Configuration file for customizing LLM provider, repository settings, and other parameters
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| eng/breakingChanges/config.ps1 | Configuration file defining LLM settings, GitHub repository paths, issue template settings, and rate limiting parameters |
| eng/breakingChanges/breaking-change-doc.ps1 | Main PowerShell script implementing the breaking change documentation workflow with data collection, LLM analysis, and issue generation |
| eng/breakingChanges/README.md | Documentation explaining the automation tool's features, setup instructions, usage examples, and configuration options |
| .github/workflows/breaking-change-doc.yml | GitHub Actions workflow that triggers the script when a PR receives the needs-breaking-change-doc-created label |
|
This is testing the workflow - #120988 Looks like it's failing to fetch the issues from dotnet/docs. I'll see if I can get it issue read permission to the docs repo. |
|
Now seeing Need to find out how to use models from a workflow. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, I look forward to using this once the technical hurdles get ironed out.
|
This works file even without the workflow, so it can be used by directly running the script after installing the github CLI. Worse case we'll just use that and occasionally run it. The summary of the problems with the workflow is that our workflows in the |
|
Tagging subscribers to this area: @dotnet/area-meta |
|
I don't expect this to work, but also trying copilot CLI provider. |
Use models. Make sure to disable tools when using copilot CLI
|
Ok, this is working now. Ready for review. |
This adds a workflow to run a script when a PR is labeled as
needs-breaking-change-doc-created,The script collects details about the PR, the breaking change issue template, and sample issues then asks an LLM to generate an issue based on that.
The issue content is then encoded into a clickable link which is then added as a comment to the PR.
I'm doing this from a dotnet branch so that I can hopefully create a PR off of it to demonstrate the workflow in action.