Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Compare against last common commit #3560

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

porter-stripe
Copy link
Collaborator

@porter-stripe porter-stripe commented May 3, 2024

Summary

  • Only compare the public interface with the commit the branch is based off of rather than master. This will ignore cases where master is ahead of the current branch and where the master branch has public API changes.

Motivation

False positives/not helpful flags
#3556 (review)

Testing

See branch commit history

Changelog

N/A

@stripe stripe deleted a comment from github-actions bot May 3, 2024
@stripe stripe deleted a comment from github-actions bot May 3, 2024
Copy link

github-actions bot commented May 3, 2024

⚠️ Public API changes detected:

StripePayments

- @objc public var allowRedisplay: StripePayments.STPPaymentMethodAllowRedisplay
- @objc convenience public init(card: StripePayments.STPPaymentMethodCardParams, billingDetails: StripePayments.STPPaymentMethodBillingDetails?, allowRedisplay: StripePayments.STPPaymentMethodAllowRedisplay = .unspecified, metadata: [Swift.String : Swift.String]?)
+ @objc convenience public init(card: StripePayments.STPPaymentMethodCardParams, billingDetails: StripePayments.STPPaymentMethodBillingDetails?, metadata: [Swift.String : Swift.String]?)
- @objc convenience public init(usBankAccount: StripePayments.STPPaymentMethodUSBankAccountParams, billingDetails: StripePayments.STPPaymentMethodBillingDetails, allowRedisplay: StripePayments.STPPaymentMethodAllowRedisplay = .unspecified, metadata: [Swift.String : Swift.String]?)
+ @objc convenience public init(usBankAccount: StripePayments.STPPaymentMethodUSBankAccountParams, billingDetails: StripePayments.STPPaymentMethodBillingDetails, metadata: [Swift.String : Swift.String]?)
- case unspecified
- case limited
- case always
- public init?(rawValue: Swift.Int)
- public typealias RawValue = Swift.Int
- public var rawValue: Swift.Int {
- get
- }

If you are adding a new public API consider the following:

  • Do these APIs need to be public or can they be protected with @_spi(STP)?
  • If these APIs need to be public, assess whether they require an API review.

If you are modifying or removing a public API:

  • Does this require a breaking version change?
  • Do these changes require API review?

If you confirm these APIs need to be added/updated and have undergone necessary review, add the label modifies public API to this PR to acknowledge and bypass this check.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant