Introduce adyen to CI pipeline for public API changes detection #5484

facumenzella · 2025-08-18T10:24:28Z

Motivation

A couple of weeks ago we realized we broke the public API. For better API stability and change control, the job should fail on any API modifications - whether breaking or non-breaking - to ensure all changes are intentional and properly reviewed.

With changes

Without changes

Description of Changes

Use https://www.adyen.com/knowledge-hub/swift-api-diff to detect API changes (only RevenueCat for now, RevenueCatUI coming next):

Add baseline swift interface files
Re-generate those on each PR. Compare them to the baselines
Added Adyen to RC orb (3.3.0)

When detecting changes, there's a lane to run locally that re-generates the swift interface files to replace the baselines. This makes reviewing public changes easier for everybody

On my mind

I think that we could only store a hash for each file instead of the whole file; but that's an optimization that we can easily add later.
Once we move this to other repos, we might consider moving some lanes to the shared plugin to reuse them

emerge-tools · 2025-08-18T10:52:42Z

📸 Snapshot Test

68 modified, 625 unchanged

Name	Modified	Unchanged	Approval
RevenueCat com.revenuecat.PaywallsTester.mac-catalyst-scaled-to-match-ipad	68	163	⏳ Needs approval
RevenueCat com.revenuecat.PaywallsTester.mac-catalyst-optimized-for-mac	0	231	N/A
RevenueCat com.revenuecat.PaywallsTester	0	231	N/A

🛸 Powered by Emerge Tools

JayShortway · 2025-08-18T14:13:50Z

.circleci/config.yml

          name: Update paywall templates
          command: bundle exec fastlane ios update_paywall_preview_resources_commit

+  check-api-changes:


Would be great if we could add these to our CircleCI orb so we can use them in other repos (e.g. PHC) too.

I am thinking about moving the job to the orb, and the script to our fastlane plugin as an action so we can reuse everything

Even better, yes let's do that 😄

RCGitBot · 2025-08-21T08:26:09Z

👁️‍🗨️ API DIFF

iOS Simulator

Status: ❌ Changes detected

⚠ We should not end up here - investigate how this happened

👀 2 public changes detected

❇️	2 Additions

`PaywallComponent`

❇️ Added

public enum AnimationType: RevenueCat.PaywallComponentBase, Swift.String {
  case easeIn
  case easeInOut
  case easeOut
  case linear
  public init(from decoder: any Swift.Decoder) throws
  public init?(rawValue: Swift.String)
  public typealias RawValue = Swift.String
  public var rawValue: Swift.String { get }
}

public struct Animation: RevenueCat.PaywallComponentBase {
  public func encode(to encoder: any Swift.Encoder) throws -> Swift.Void
  public func hash(into hasher: inout Swift.Hasher) -> Swift.Void
  public init(from decoder: any Swift.Decoder) throws
  public let msDelay: Swift.Int { get }
  public let msDuration: Swift.Int { get }
  public let type: RevenueCat.PaywallComponent.AnimationType { get }
  public static func ==(
    a: RevenueCat.PaywallComponent.Animation,
    b: RevenueCat.PaywallComponent.Animation
  ) -> Swift.Bool
  public var hashValue: Swift.Int { get }
}

iOS

Status: ❌ Changes detected

⚠ We should not end up here - investigate how this happened

👀 2 public changes detected

❇️	2 Additions

`PaywallComponent`

❇️ Added

public enum AnimationType: RevenueCat.PaywallComponentBase, Swift.String {
  case easeIn
  case easeInOut
  case easeOut
  case linear
  public init(from decoder: any Swift.Decoder) throws
  public init?(rawValue: Swift.String)
  public typealias RawValue = Swift.String
  public var rawValue: Swift.String { get }
}

public struct Animation: RevenueCat.PaywallComponentBase {
  public func encode(to encoder: any Swift.Encoder) throws -> Swift.Void
  public func hash(into hasher: inout Swift.Hasher) -> Swift.Void
  public init(from decoder: any Swift.Decoder) throws
  public let msDelay: Swift.Int { get }
  public let msDuration: Swift.Int { get }
  public let type: RevenueCat.PaywallComponent.AnimationType { get }
  public static func ==(
    a: RevenueCat.PaywallComponent.Animation,
    b: RevenueCat.PaywallComponent.Animation
  ) -> Swift.Bool
  public var hashValue: Swift.Int { get }
}

macOS

Status: ❌ Changes detected

⚠ We should not end up here - investigate how this happened

👀 2 public changes detected

❇️	2 Additions

`PaywallComponent`

❇️ Added

public enum AnimationType: RevenueCat.PaywallComponentBase, Swift.String {
  case easeIn
  case easeInOut
  case easeOut
  case linear
  public init(from decoder: any Swift.Decoder) throws
  public init?(rawValue: Swift.String)
  public typealias RawValue = Swift.String
  public var rawValue: Swift.String { get }
}

public struct Animation: RevenueCat.PaywallComponentBase {
  public func encode(to encoder: any Swift.Encoder) throws -> Swift.Void
  public func hash(into hasher: inout Swift.Hasher) -> Swift.Void
  public init(from decoder: any Swift.Decoder) throws
  public let msDelay: Swift.Int { get }
  public let msDuration: Swift.Int { get }
  public let type: RevenueCat.PaywallComponent.AnimationType { get }
  public static func ==(
    a: RevenueCat.PaywallComponent.Animation,
    b: RevenueCat.PaywallComponent.Animation
  ) -> Swift.Bool
  public var hashValue: Swift.Int { get }
}

watchOS Simulator

Status: ❌ Changes detected

⚠ We should not end up here - investigate how this happened

👀 2 public changes detected

❇️	2 Additions

`PaywallComponent`

❇️ Added

public enum AnimationType: RevenueCat.PaywallComponentBase, Swift.String {
  case easeIn
  case easeInOut
  case easeOut
  case linear
  public init(from decoder: any Swift.Decoder) throws
  public init?(rawValue: Swift.String)
  public typealias RawValue = Swift.String
  public var rawValue: Swift.String { get }
}

public struct Animation: RevenueCat.PaywallComponentBase {
  public func encode(to encoder: any Swift.Encoder) throws -> Swift.Void
  public func hash(into hasher: inout Swift.Hasher) -> Swift.Void
  public init(from decoder: any Swift.Decoder) throws
  public let msDelay: Swift.Int { get }
  public let msDuration: Swift.Int { get }
  public let type: RevenueCat.PaywallComponent.AnimationType { get }
  public static func ==(
    a: RevenueCat.PaywallComponent.Animation,
    b: RevenueCat.PaywallComponent.Animation
  ) -> Swift.Bool
  public var hashValue: Swift.Int { get }
}

watchOS

Status: ❌ Changes detected

⚠ We should not end up here - investigate how this happened

👀 2 public changes detected

❇️	2 Additions

`PaywallComponent`

❇️ Added

public enum AnimationType: RevenueCat.PaywallComponentBase, Swift.String {
  case easeIn
  case easeInOut
  case easeOut
  case linear
  public init(from decoder: any Swift.Decoder) throws
  public init?(rawValue: Swift.String)
  public typealias RawValue = Swift.String
  public var rawValue: Swift.String { get }
}

public struct Animation: RevenueCat.PaywallComponentBase {
  public func encode(to encoder: any Swift.Encoder) throws -> Swift.Void
  public func hash(into hasher: inout Swift.Hasher) -> Swift.Void
  public init(from decoder: any Swift.Decoder) throws
  public let msDelay: Swift.Int { get }
  public let msDuration: Swift.Int { get }
  public let type: RevenueCat.PaywallComponent.AnimationType { get }
  public static func ==(
    a: RevenueCat.PaywallComponent.Animation,
    b: RevenueCat.PaywallComponent.Animation
  ) -> Swift.Bool
  public var hashValue: Swift.Int { get }
}

RevenueCat-Danger-Bot · 2025-08-22T14:44:39Z

	2 Warnings
⚠️	Size check is being bypassed due to the presence of the label "danger-bypass-size-limit"
⚠️	Size increase: 1181.45 KB

Generated by 🚫 Danger

facumenzella added 4 commits August 18, 2025 12:23

Test swiftinterface for RevenueCat

9cc47da

tweak swiftinterface path

88e1212

correct use of tool

8c10273

compare swift interface, not project

66d356a

facumenzella added 3 commits August 18, 2025 13:21

test all platforms

db3c9c6

test api break

c8dbd58

swap params order

7cbc980

JayShortway reviewed Aug 18, 2025

View reviewed changes

test commenting directly

93f8b89

facumenzella force-pushed the feat/swiftinterface branch from 0e11def to 93f8b89 Compare August 19, 2025 10:28

RevenueCat deleted a comment from RCGitBot Aug 19, 2025

tweak how public-api-diff is accessed

6bd73fc

facumenzella force-pushed the feat/swiftinterface branch from fed96c5 to 6bd73fc Compare August 19, 2025 11:04

RevenueCat deleted a comment from RCGitBot Aug 19, 2025

facumenzella added 3 commits August 19, 2025 13:42

deleted extra

93023c2

Merge branch 'main' into feat/swiftinterface

e12eb66

test flow without changes

725c164

RevenueCat deleted a comment from RCGitBot Aug 19, 2025

facumenzella added 2 commits August 19, 2025 15:47

test using 16.3

50d8dc1

upload new ones as artifacts

c0fcfc2

RevenueCat deleted a comment from RCGitBot Aug 19, 2025

facumenzella added 4 commits August 19, 2025 17:38

Generate files without DEBUG

7998126

updates for api comment

d6c9f3f

test new approach

3789c5d

Use orb instead of manual installation

e531694

facumenzella force-pushed the feat/swiftinterface branch from db3254d to e531694 Compare August 21, 2025 07:58

bump rc orb

cf33652

RevenueCat deleted a comment from RCGitBot Aug 21, 2025

update comment format

b1ae10b

RevenueCat deleted a comment from RCGitBot Aug 21, 2025

facumenzella added 3 commits August 21, 2025 17:44

not finished

1abb948

test public interface error

e0ec36c

test output again

62ae3fa

facumenzella added the pr:other label Aug 22, 2025

RevenueCat deleted a comment from RevenueCat-Danger-Bot Aug 22, 2025

facumenzella added the danger-bypass-size-limit Apply this label to bypass Dangerbot's size limit. label Aug 22, 2025

revert change

75996ed

facumenzella requested a review from JayShortway August 22, 2025 14:59

facumenzella marked this pull request as ready for review August 22, 2025 14:59

Merge branch 'main' into feat/swiftinterface

85e6469

facumenzella requested a review from a team August 22, 2025 15:13

facumenzella changed the title ~~Test swiftinterface for RevenueCat~~ Aug 22, 2025

facumenzella requested a review from ajpallares August 22, 2025 15:14

Merge branch 'main' into feat/swiftinterface

599414a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Introduce adyen to CI pipeline for public API changes detection #5484

Introduce adyen to CI pipeline for public API changes detection #5484

Uh oh!

facumenzella commented Aug 18, 2025 •

edited

Loading

emerge-tools bot commented Aug 18, 2025 •

edited

Loading

JayShortway Aug 18, 2025

facumenzella Aug 19, 2025

JayShortway Sep 24, 2025

RCGitBot commented Aug 21, 2025 •

edited

Loading

RevenueCat-Danger-Bot commented Aug 22, 2025

Labels

5 participants

Introduce adyen to CI pipeline for public API changes detection #5484

Are you sure you want to change the base?

Introduce adyen to CI pipeline for public API changes detection #5484

Uh oh!

Conversation

facumenzella commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

With changes

Without changes

Description of Changes

On my mind

emerge-tools bot commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📸 Snapshot Test

68 modified, 625 unchanged

JayShortway Aug 18, 2025

Choose a reason for hiding this comment

facumenzella Aug 19, 2025

Choose a reason for hiding this comment

JayShortway Sep 24, 2025

Choose a reason for hiding this comment

RCGitBot commented Aug 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

👁️‍🗨️ API DIFF

iOS Simulator

👀 2 public changes detected

PaywallComponent

❇️ Added

iOS

👀 2 public changes detected

PaywallComponent

❇️ Added

macOS

👀 2 public changes detected

PaywallComponent

❇️ Added

watchOS Simulator

👀 2 public changes detected

PaywallComponent

❇️ Added

watchOS

👀 2 public changes detected

PaywallComponent

❇️ Added

RevenueCat-Danger-Bot commented Aug 22, 2025

Labels

5 participants

facumenzella commented Aug 18, 2025 •

edited

Loading

emerge-tools bot commented Aug 18, 2025 •

edited

Loading

RCGitBot commented Aug 21, 2025 •

edited

Loading

`PaywallComponent`

`PaywallComponent`

`PaywallComponent`

`PaywallComponent`

`PaywallComponent`