You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains 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
This PR introduces an automated mechanism to detect API breaking changes, enhancing our CI/CD pipeline's robustness and ensuring backward compatibility. The following components are included:
GitHub Action for API Breaking Change Detection:
This action triggers whenever a pull request (PR) is opened.
It checks for any API breaking changes and sends a detailed report as a comment on the PR.
If any public interface changes are detected, an admin reviewer is automatically added to the PR for further inspection.
Local Script for API Breaking Change Detection:
A script is provided to allow developers to check for API breaking changes locally before pushing their changes.
This ensures early detection and resolution of potential issues during the development phase.
Daily GitHub Action for Swift API Digester:
This action runs every morning to verify that the Swift API Digester tool works as expected.
It serves as a continuous check to ensure the reliability and accuracy of our API breaking change detection process.
General Checklist
Added new tests to cover change, if needed
Build succeeds with all target using Swift Package Manager
All unit tests pass
All integration tests pass
Security oriented best practices and standards are followed (e.g. using input sanitization, principle of least privilege, etc)
Documentation update for the change if required
PR title conforms to conventional commit style
New or updated tests include Given When Then inline code documentation and are named accordingly testThing_condition_expectation()
If breaking change, documentation/changelog update with migration instructions
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Module: Amplify
Func ModelAssociation.hasOne(associatedWith:targetNames:) has been renamed to Func hasOne(associatedWith:associatedFields:targetNames:)
EnumElement ModelAssociation.hasOne has declared type change from (Amplify.ModelAssociation.Type) -> (Swift.String?, [Swift.String]) -> Amplify.ModelAssociation to (Amplify.ModelAssociation.Type) -> (Swift.String?, [Swift.String], [Swift.String]) -> Amplify.ModelAssociation
Func ModelAssociation.hasOne(associatedWith:targetNames:) has parameter 1 type change from [Swift.String] to [Swift.CodingKey]
👉🏻 Note: If you're just adding optional parameters to existing methods, neglect the line: Func ModelAssociation.hasOne(associatedWith:targetNames:) has been renamed to Func hasOne(associatedWith:associatedFields:targetNames:)
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.
Issue #
Description
This PR introduces an automated mechanism to detect API breaking changes, enhancing our CI/CD pipeline's robustness and ensuring backward compatibility. The following components are included:
GitHub Action for API Breaking Change Detection:
Local Script for API Breaking Change Detection:
Daily GitHub Action for Swift API Digester:
General Checklist
Given When Theninline code documentation and are named accordinglytestThing_condition_expectation()By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.