[CI] Optimize public interface analyser installation (#900)

Author: testableapple

.github/workflows/smoke-checks.yml

@@ -138,6 +138,8 @@ jobs:
     steps:
     - uses: actions/[email protected]
     - 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

.gitignore

@@ -14,9 +14,12 @@ StreamVideo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
 build/
 DerivedData/
 *.xcframework
+
+# Interface Analyser
 stream-module-interface-analyser/
-public_interface_current.resolved
-public_interface_previous.resolved
+interface-analyser-report.md
+public_interface_current.*
+public_interface_previous.*
 
 ## Various settings
 *.pbxuser

Githubfile

@@ -8,3 +8,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

@@ -87,3 +87,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

@@ -729,27 +729,23 @@ end
 lane :validate_public_interface do
   next unless is_check_required(sources: sources_matrix[:public_interface], force_check: @force_check)
 
-  analyser = 'interface-analyser'
-  sh("wget -P . https://github.com/GetStream/stream-module-interface-analyser/releases/download/v1.0.7/interface-analyser")
-  sh("chmod +x #{analyser}")
-
   # Run the analysis on the current branch
   original_branch = current_branch
-  sh("./#{analyser} analysis ../Sources/ ../public_interface_current.json")
+  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("./#{analyser} analysis ../Sources/ ../public_interface_previous.json")
+  sh('interface-analyser analysis ../Sources/ public_interface_previous.json')
 
   # Run diff
-  report_path = '../report.md'
-  sh("./#{analyser} diff ../public_interface_current.json ../public_interface_previous.json #{report_path}")
+  report_path = 'interface-analyser-report.md'
+  sh("interface-analyser diff public_interface_current.json public_interface_previous.json #{report_path}")
 
-  # Check if report.md exists and is non-zero in size
+  # 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