Skip to content

Conversation

@ericstj
Copy link
Member

@ericstj ericstj commented Oct 22, 2025

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.

@ericstj ericstj requested review from a team and rzikm October 22, 2025 21:22
@ericstj ericstj requested a review from jeffhandley as a code owner October 22, 2025 21:22
Copilot AI review requested due to automatic review settings October 22, 2025 21:22
@github-actions github-actions bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Oct 22, 2025
Copy link
Contributor

Copilot AI left a 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

@ericstj
Copy link
Member Author

ericstj commented Oct 22, 2025

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.

@ericstj
Copy link
Member Author

ericstj commented Oct 22, 2025

Now seeing Error: unexpected response from the server: 403 Forbidden

Need to find out how to use models from a workflow.

Copy link
Member

@rzikm rzikm left a 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.

@ericstj
Copy link
Member Author

ericstj commented Oct 23, 2025

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 dotnet org don't have access to github models, and that's currently not a technical problem. I can unblock that by storing a secret in the repo as a token for another LLM provider, but I don't like storing/needing-to-update a secret.

@ericstj ericstj added area-Meta and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels Oct 24, 2025
@dotnet-policy-service
Copy link
Contributor

Tagging subscribers to this area: @dotnet/area-meta
See info in area-owners.md if you want to be subscribed.

@ericstj
Copy link
Member Author

ericstj commented Oct 24, 2025

I don't expect this to work, but also trying copilot CLI provider.

@ericstj
Copy link
Member Author

ericstj commented Oct 24, 2025

Ok, this is working now. Ready for review.

@ericstj ericstj requested review from a team and removed request for a team October 29, 2025 00:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants