Skip to content

Commit

Permalink
Update PR comment
Browse files Browse the repository at this point in the history
  • Loading branch information
DaveTryon committed Jan 22, 2025
1 parent e6844ae commit e340b0d
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions .github/workflows/pr-comment-api-change.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
You touched the API project. Did you change _any_ of the API interfaces in _any way_? If so, this is an API-breaking change. Please be sure you do the following:
This PR changes files in the API project. Does it change _any_ of the API interfaces in _any way_? Please note that this includes the following types of changes:
- Changing the signature of an existing interface method
- Adding a new method to an existing interface
- Adding a required data member to a class that an existing interface method consumes

1. Bump the major version in the next release
2. Update the documentation to show the new functionality
Because any of these changes can potentially break a downstream consumer with customized interface implementations, these changes need to be treated as breaking changes. Please do one of the following:

## Option 1 - Publish this as a breaking change
1. Update the documentation to show the new functionality and/or explain the change
2. Bump the major version in the next release

## Option 2 - Refactor the changes to be non-breaking
1. Review [this commit](https://github.com/microsoft/sbom-tool/commit/4d0ce83e194ed6feace53666aeb6280f5b8b8769), which adds a new interface in a backward-compatible way
2. Refactor the change to follow this pattern so that existing interfaces are left completely intact
3. Bump the minor version in the next release

0 comments on commit e340b0d

Please sign in to comment.