Add a workflow to comment on API changes #885
Merged
Conversation
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
Contributor
Author
|
/azp run |
JoseRenan
approved these changes
Jan 22, 2025
Contributor
Author
|
/azp run |
Contributor
Author
|
/azp run |
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.
Last year, we introduced a breaking change into the API without taking the versioning into account. In order to prevent that sort of change in the future, this PR adds a workflow that inserts a PR comment to encourage people to think through the versioning before merging the PR. This was developed and iterated in #884, and you can view the PR comment on this PR comment.
The PR comment itself lives in a markdown file, so extending the comment itself is straightforward.
This workflow is targeted by changes to
.csfiles in thesrc\Microsoft.Sbom.Apipath, so this workflow will not run on PR's that do not satisfy the targeting requirement. It will also run after each push to the PR--we may want to scale that down eventually, but for now, it's a good way to ensure that we're catching all the changes.