Add a workflow to comment on API changes by DaveTryon · Pull Request #885 · microsoft/sbom-tool (original) (raw)

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 .cs files in the src\Microsoft.Sbom.Api path, 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.