feat: Add GitHub Action to notify SDK repositories of API changes on release#134
Open
feat: Add GitHub Action to notify SDK repositories of API changes on release#134
Conversation
Co-authored-by: teolemon <1689815+teolemon@users.noreply.github.com>
…sting Co-authored-by: teolemon <1689815+teolemon@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Task
Add GitHub Action to notify SDK repositories of API changes on release
Sep 29, 2025
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
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.
This PR implements an automated GitHub Action workflow that creates issues in OpenFoodFacts SDK repositories whenever a NutriPatrol release contains API changes.
Problem
When NutriPatrol releases include API changes, SDK maintainers across multiple repositories need to be manually notified to update their implementations. This manual process is error-prone and can lead to outdated SDKs.
Solution
The new workflow (
.github/workflows/notify-sdk-api-changes.yml) automatically:Target Repositories
When API changes are detected, issues are created in:
Issue Template
Each generated issue includes:
enhancement,api-update)API Change Detection
The workflow uses pattern matching to detect API-related terms:
Error Handling
The workflow includes:
Testing
The implementation has been thoroughly tested with:
Documentation
Added
docs/sdk-notification-workflow.mdexplaining the workflow configuration and testing approach.This automation ensures SDK maintainers are promptly and consistently notified of API changes, improving the overall ecosystem's responsiveness to NutriPatrol updates.
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.