feat: Add GitHub annotations for breaking changes to a package's API (#298)

* feat: Add GitHub annotations for breaking changes to a package's API

* docs: Update changelog with info about the GitHub annotations added to the API check workflow

Author: nfelt14

.github/workflows/_reusable-check-api-for-breaking-changes.yml

@@ -25,6 +25,10 @@ jobs:
         run: |
           pip install --upgrade .
           pip install griffe
+      - name: Post breaking changes as GitHub annotations
+        continue-on-error: true
+        run: |
+          griffe check --format=github --against="$(git rev-parse origin/main)" --search=src "$PACKAGE_NAME"
       - name: Check API for breaking changes
         continue-on-error: true
         run: |

CHANGELOG.md

@@ -22,6 +22,10 @@ Things to be included in the next release go here.
 
 - Bumped dependency versions.
 
+### Added
+
+- Added GitHub annotations to the `check-api-for-breaking-changes` workflow to enable better visibility into any breaking changes detected.
+
 ---
 
 ## v1.5.3 (2024-12-04)