[CI] Implement public interface validation

Author: testableapple

.github/workflows/smoke-checks.yml

@@ -53,6 +53,9 @@ jobs:
     steps:
     - uses: actions/checkout@v4.1.1
     - uses: ./.github/actions/bootstrap
+      env:
+        INSTALL_INTERFACE_ANALYZER: true
+    - run: bundle exec fastlane validate_public_interface
     - run: bundle exec fastlane lint_pr
     - run: bundle exec fastlane rubocop
     - run: bundle exec fastlane run_swift_format strict:true

.gitignore

@@ -14,6 +14,12 @@ StreamChatSwiftUI.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.res
 build/
 DerivedData/
 
+# Interface Analyser
+stream-module-interface-analyser/
+interface-analyser-report.md
+public_interface_current.*
+public_interface_previous.*
+
 ## Various settings
 *.pbxuser
 !default.pbxuser

Githubfile

@@ -6,3 +6,4 @@ export YEETD_VERSION='1.0'
 export MINT_VERSION='0.17.5'
 export SONAR_VERSION='6.2.1.4610'
 export IPSW_VERSION='3.1.592'
+export INTERFACE_ANALYZER_VERSION='1.0.7'

Scripts/bootstrap.sh

@@ -79,3 +79,11 @@ if [[ ${INSTALL_IPSW-default} == true ]]; then
   chmod +x ipsw
   sudo mv ipsw /usr/local/bin/
 fi
+
+if [[ ${INSTALL_INTERFACE_ANALYZER-default} == true ]]; then
+  puts "Install interface-analyser v${INTERFACE_ANALYZER_VERSION}"
+  FILE="interface-analyser"
+  wget "https://github.com/GetStream/stream-module-interface-analyser/releases/download/v${INTERFACE_ANALYZER_VERSION}/${FILE}"
+  chmod +x ${FILE}
+  sudo mv ${FILE} /usr/local/bin/
+fi

fastlane/Fastfile

@@ -530,6 +530,7 @@ lane :sources_matrix do
     ruby: ['fastlane', 'Gemfile', 'Gemfile.lock'],
     size: ['Sources', xcode_project],
     sonar: ['Sources'],
+    interface_analyser: ['Sources'],
     swiftformat_include: ['Sources', 'DemoAppSwiftUI', 'StreamChatSwiftUITests'],
     swiftformat_exclude: ['**/Generated', 'Sources/StreamChatSwiftUI/StreamNuke', 'Sources/StreamChatSwiftUI/StreamSwiftyGif']
   }
@@ -545,6 +546,45 @@ lane :copyright do
   )
 end
 
+lane :validate_public_interface do
+  next unless is_check_required(sources: sources_matrix[:public_interface], force_check: @force_check)
+
+  # Run the analysis on the current branch
+  original_branch = current_branch
+  sh('interface-analyser analysis ../Sources/ public_interface_current.json')
+
+  # Checkout the target branch
+  target_branch = original_branch.include?('release/') ? 'main' : 'develop'
+  sh("git fetch origin #{target_branch}")
+  sh("git checkout #{target_branch}")
+
+  # Run the analysis on the target branch
+  sh('interface-analyser analysis ../Sources/ public_interface_previous.json')
+
+  # Run diff
+  report_path = 'interface-analyser-report.md'
+  sh("interface-analyser diff public_interface_current.json public_interface_previous.json #{report_path}")
+
+  # Check if report exists and is non-zero in size
+  diff =
+    if File.exist?(report_path) && File.size(report_path) > 0
+      File.read(report_path).strip
+    else
+      '🚀 No changes affecting the public interface.'
+    end
+
+  # Generate markdown table for the PR comment
+  header = '## Public Interface'
+  content = "#{header}\n#{diff}"
+
+  # Post PR comment if running in CI
+  pr_comment(text: content, edit_last_comment_with_text: header) if is_ci
+
+  # Checkout the original branch
+  sh("git fetch origin #{original_branch}")
+  sh("git checkout #{original_branch}")
+end
+
 lane :show_frameworks_sizes do |options|
   next unless is_check_required(sources: sources_matrix[:size], force_check: @force_check)