fastlane-plugin-fastci 0.0.20 → 0.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1c8c592c87f4597919d8a5534434ed422a94d0560be2ddb2a82353aefe43648
-  data.tar.gz: c17fd86d0c3084917668534196fe01053078952f6cdf30e81cf14c50b34dcd2f
+  metadata.gz: 9eadcd995669c5cfd0d4d8a28b68667d0d18cdd710864eed98ed142e285c9b93
+  data.tar.gz: 2fa4908e62aedb5faa2ad21a5f6d4d5e210bf609848721c621856c84f80e9741
 SHA512:
-  metadata.gz: 6cee5ced946a258e71e30e8c7c7a445e6182ecc61aee1e1cf8a524486ec64a96c8b71eec99f259d58502296c4813c03ad915b6e8ae8b69519e85840306793f77
-  data.tar.gz: ef562edaf613408355e8752fe5104948c5f39b2ea156ce241fd57cacefa36503e5199c6dd21b7afeac2edd8202531c9998bd00f05328ac0b766f02a25228a0ae
+  metadata.gz: 1606d02bc136b88b61652ad9218f7a3428ba36a516eb578d738328b12750abeb04b9caa7f30eebe790efae4e4019961c6429089f8d0d247cdc8ebd76e5ad2252
+  data.tar.gz: 3cf569702228448922d1d20e296900fc2c7594d3c51d3f82ef6ea0e88addc85227f27c3ea050a81ad45ce0630e5a5647aeab82a800b3433e8430eb31fc555d7a

data/README.md

@@ -53,6 +53,7 @@ fastlane_cache/ # 插件缓存文件夹
 功能：自动编译并导出 ipa 包，支持多种打包方式和集成多项检查。
 生成完的 ipa 会放在桌面上，非 ` app-store ` 配置了蒲公英或 fir 参数会自动上传蒲公英或 fir。` app-store ` 和 ` testFlight ` 配置了商店参数会自动上传商店。
 配置了 Sentry 参数会自动上传符号表。
+配置了 Zealot 参数的非商店包也可自动上传，详见下方 Zealot 配置。
 
 ` build `: 不指定的话内部有递增逻辑，格式为 ` 20250905.15（日期+当天包的次数） `
 
@@ -124,6 +125,89 @@ detect_unused_image(
 
 ---
 
+### 6. Zealot（仅 iOS）
+
+通过官方 [fastlane-plugin-zealot](https://github.com/tryzealot/fastlane-plugin-zealot) 封装以下独立 Action：
+
+| Action | 用途 |
+| --- | --- |
+| `upload_zealot` | 上传 IPA，返回版本与下载地址 |
+| `upload_zealot_dsym` | 上传 iOS dSYM，支持 zip 或 xcarchive |
+| `check_zealot_version` | 按 Bundle ID、版本号或 commit 查询版本 |
+| `sync_zealot_devices` | 将 Apple 开发者账号中的 iOS 设备同步到 Zealot |
+
+在本机环境文件或 CI 密钥中配置，真实 token 不要提交到仓库：
+
+```dotenv
+ZEALOT_ENDPOINT=https://zealot.example.com
+ZEALOT_TOKEN=your-user-token
+ZEALOT_CHANNEL_KEY=your-ios-channel-key
+ZEALOT_UPLOAD_DSYM=false
+```
+
+`package` 与 Fir 一样按 token 判断是否上传：配置 `ZEALOT_TOKEN` 后，自动上传 `development`、`ad-hoc`、`enterprise` 包；token 留空时跳过。上传时必须同时提供 `ZEALOT_ENDPOINT` 和 `ZEALOT_CHANNEL_KEY`。`app-store` 和 `testFlight` 保持原上传流程。
+
+```ruby
+package(
+  export_method: "development",
+  is_upload_zealot_dsym: true,  # 默认 false；仅 IPA 上传成功后执行
+  changelog: "iOS 更新说明"
+)
+```
+
+也可以单独调用，不需要重新构建：
+
+```ruby
+result = upload_zealot(file: "./App.ipa", changelog: "iOS 更新说明")
+# result：app_id、release_id、release_url、install_url、qrcode_url
+
+upload_zealot_dsym(zip_file: "./App.app.dSYM.zip")
+# 或指定 path: "./App.xcarchive"；均未指定时使用本次 gym 产物。
+
+exists = check_zealot_version(
+  bundle_id: "com.example.app",
+  release_version: "1.0",
+  build_version: "1"
+)
+# 也可用 git_commit 替代 release_version / build_version。
+
+sync_zealot_devices(api_key_path: "./app_store_connect_api_key.json")
+# 也可使用 username / team_id；设备同步不会在 package 中自动执行。
+```
+
+请求失败默认终止 lane，可传 `fail_on_error: false` 或设置 `ZEALOT_FAIL_ON_ERROR=false` 继续执行。版本查询返回 `true`（存在）、`false`（不存在）、`nil`（请求失败且允许继续）；设备同步返回 `total`、`succeeded`、`failed`。token 在请求摘要中始终隐藏。
+
+上传参数支持官方的 `password`、`timeout`、`verify_ssl`、`branch`、`git_commit` 等选项，使用 `bundle exec fastlane action upload_zealot` 查看。示例 Fastfile 也提供 `uploadZealot`、`uploadZealotDsym`、`checkZealotVersion`、`syncZealotDevices` 四个 lane。
+
+依赖兼容：Zealot 的 `debug_file` 依赖 `ruby-macho < 3`，不能与 CocoaPods 1.17（依赖 4.x）放在同一 bundle。此类工程应将 CocoaPods 放入独立 Gemfile；使用 Faraday 1 的 Fastlane 工程还应将 `faraday-net_http` 限制为 `~> 1.0`。
+
+## 发布到 RubyGems
+
+工作流位于 [`.github/workflows/release.yml`](.github/workflows/release.yml)。使用 `1.0.0` 这样的纯版本标签，无需 `v` 前缀。推送数字开头的标签后，自动校验标签与 `lib/fastlane/plugin/fastci/version.rb` 中的 `VERSION` 完全一致，检查 Ruby 语法、构建 gem 并发布到 RubyGems。
+
+首次使用需完成一次 [RubyGems Trusted Publishing 配置](https://guides.rubygems.org/trusted-publishing/)：
+
+用 gem 所有者账号打开 [fastlane-plugin-fastci](https://rubygems.org/gems/fastlane-plugin-fastci)，进入 **Trusted publishers → Create**，填写：
+
+| 字段 | 值 |
+| --- | --- |
+| Repository owner | `watermelon520` |
+| Repository name | `fastlane-plugin-fastci` |
+| Workflow filename | `release.yml` |
+| Environment | 留空（可选） |
+
+工作流使用官方 OIDC 短期凭据，不需要配置 `RUBYGEMS_API_KEY` 或创建 GitHub Environment。工作流文件在当前仓库内，Workflow Repository 两项留空。若以后设置 Environment，RubyGems 配置与工作流的 `environment` 必须保持一致。
+
+每次发布先修改 `VERSION`，执行 `bundle install` 同步 `Gemfile.lock`，并提交本次拟发布的代码和工作流。然后推送对应标签，例如版本更新为 `0.0.30` 后：
+
+```bash
+git push origin main
+git tag -a 0.0.30 -m "Release 0.0.30"
+git push origin 0.0.30
+```
+
+到 GitHub **Actions → Release to RubyGems** 查看结果。已发布版本不能覆盖；失败重跑前先确认该版本是否已经发布。只有打入标签提交的文件会被发布，本地未提交改动不会包含在内。
+
 ## 贡献与支持
 
 如需更多帮助或贡献，请提交 Issue 或 PR。

data/lib/fastlane/plugin/fastci/actions/check_zealot_version_action.rb

@@ -0,0 +1,52 @@
+require 'fastlane/plugin/fastci/helper/fastci_zealot_helper'
+
+module Fastlane
+  module Actions
+    # 查询 iOS 应用已上传版本，是否跳过后续打包由调用方决定。
+    class CheckZealotVersionAction < ZealotVersionCheckAction
+      extend Fastlane::Helper::FastciZealotHelper
+
+      def self.run(params)
+        validate_zealot_connection!(zealot_parameters(params))
+        [
+          SharedValues::ZEALOT_VERSION_EXISTED,
+          SharedValues::ZEAALOT_ERROR_MESSAGE,
+          SharedValues::ZEALOT_LATEST_RELEASE_ID,
+          SharedValues::ZEALOT_LATEST_RELEASE_VERSION,
+          SharedValues::ZEALOT_LATEST_VERSION,
+          SharedValues::ZEALOT_LATEST_RELEASE_URL,
+          SharedValues::ZEALOT_LATEST_INSTALL_URL,
+          SharedValues::ZEALOT_LATEST_QRCODE_URL,
+          SharedValues::ZEALOT_LATEST_CONTEXT
+        ].each { |key| Actions.lane_context.delete(key) }
+
+        response = check_app_version(params)
+        # 上游非终止模式在网络错误时返回 false，不能继续读取 response.status。
+        return nil unless response
+
+        unless [200, 404].include?(response.status) && response.body.is_a?(Hash)
+          show_error("Zealot 版本查询失败（HTTP #{response.status}）", params[:fail_on_error])
+          return nil
+        end
+
+        parse_response(response, params[:fail_on_error])
+      end
+
+      def self.available_options
+        zealot_options(ZealotVersionCheckAction)
+      end
+
+      def self.description
+        '按 Bundle ID 与版本号或 Git commit 查询 Zealot，返回是否已存在'
+      end
+
+      def self.example_code
+        ['check_zealot_version(bundle_id: "com.example.app", release_version: "1.0", build_version: "1")']
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/fastci/actions/package_action.rb

@@ -182,6 +182,18 @@ module Fastlane
             end
           end
 
+          # 上传 Zealot
+          if CommonHelper.is_validate_string(Environment.zealot_token)
+            zealot_upload_info = other_action.upload_zealot(
+              file: ipa_path,
+              changelog: params[:changelog]
+            )
+            # dSYM 仅在 IPA 上传成功且显式开启时上传。
+            if zealot_upload_info && params[:is_upload_zealot_dsym]
+              other_action.upload_zealot_dsym
+            end
+          end
+
           send_dingding_notice.call(notiText)
         end
 
@@ -261,6 +273,14 @@ module Fastlane
 
       def self.available_options
         [
+          FastlaneCore::ConfigItem.new(
+            key: :is_upload_zealot_dsym,
+            env_name: 'ZEALOT_UPLOAD_DSYM',
+            description: 'IPA 上传 Zealot 成功后继续上传 iOS dSYM',
+            optional: true,
+            default_value: false,
+            type: Boolean
+          ),
           FastlaneCore::ConfigItem.new(
             key: :scheme,
             description: '不采取默认配置，自定义 `scheme` 名称',

data/lib/fastlane/plugin/fastci/actions/sync_zealot_devices_action.rb

@@ -0,0 +1,65 @@
+require 'fastlane/plugin/fastci/helper/fastci_zealot_helper'
+
+module Fastlane
+  module Actions
+    # 手动同步 Apple 开发者账号中的 iOS 设备，不挂入自动打包流程。
+    class SyncZealotDevicesAction < ZealotSyncDevicesAction
+      extend Fastlane::Helper::FastciZealotHelper
+
+      def self.run(params)
+        validate_zealot_connection!(zealot_parameters(params))
+        Actions.lane_context.delete(SharedValues::ZEAALOT_ERROR_MESSAGE)
+        devices = fetch_ios_devices(params)
+        print_table(build_table_data(params, devices), title: 'sync_zealot_devices')
+
+        # 沿用官方的设备上传协议，按实际 HTTP 结果统计，避免失败被计为成功。
+        failed = devices.count { |device| !sync_ios_device(params, device) }
+        result = { total: devices.size, succeeded: devices.size - failed, failed: failed }
+        UI.message("Zealot iOS 设备同步：成功 #{result[:succeeded]}，失败 #{failed}")
+        result
+      end
+
+      def self.fetch_ios_devices(params)
+        require 'spaceship'
+
+        token = Spaceship::ConnectAPI::Token.from(hash: params[:api_key], filepath: params[:api_key_path])
+        if token
+          Spaceship::ConnectAPI.token = token
+          return Spaceship::ConnectAPI::Device.all(filter: { platform: 'IOS' })
+        end
+
+        credentials = CredentialsManager::AccountManager.new(user: params[:username])
+        Spaceship.login(credentials.user, credentials.password)
+        Spaceship.select_team
+        Spaceship::Device.all(mac: false)
+      end
+      private_class_method :fetch_ios_devices
+
+      def self.sync_ios_device(params, device)
+        response = sync_deivce(params, device)
+        return true if response.success?
+
+        show_error("Zealot 设备同步失败（HTTP #{response.status}）", params[:fail_on_error])
+      rescue Faraday::ConnectionFailed, Faraday::TimeoutError => error
+        show_error("Zealot 设备同步请求失败：#{error.class}", params[:fail_on_error])
+      end
+      private_class_method :sync_ios_device
+
+      def self.available_options
+        zealot_options(ZealotSyncDevicesAction, excluding: [:platform])
+      end
+
+      def self.description
+        '同步 Apple 开发者账号中的 iOS 设备到 Zealot'
+      end
+
+      def self.example_code
+        ['sync_zealot_devices(api_key_path: "./app_store_connect_api_key.json")']
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/fastci/actions/upload_zealot_action.rb

@@ -0,0 +1,58 @@
+require 'fastlane/plugin/fastci/helper/fastci_zealot_helper'
+
+module Fastlane
+  module Actions
+    # iOS IPA 上传：沿用官方传输与结果解析，避免复制 Zealot HTTP 协议。
+    class UploadZealotAction < ZealotAction
+      extend Fastlane::Helper::FastciZealotHelper
+
+      def self.run(params)
+        validate_zealot_connection!(zealot_parameters(params))
+        UI.user_error!('请指定 IPA 文件或先执行 gym/package') if params[:file].to_s.empty?
+
+        # 同一 lane 可多次上传，失败时不能返回上一次上传的地址。
+        output.each { |key, _description| Actions.lane_context.delete(key.to_sym) }
+        super(params)
+        return nil unless Actions.lane_context[SharedValues::ZEALOT_RELEASE_ID]
+
+        {
+          app_id: Actions.lane_context[SharedValues::ZEALOT_APP_ID],
+          release_id: Actions.lane_context[SharedValues::ZEALOT_RELEASE_ID],
+          release_url: Actions.lane_context[SharedValues::ZEALOT_RELEASE_URL],
+          install_url: Actions.lane_context[SharedValues::ZEALOT_INSTALL_URL],
+          qrcode_url: Actions.lane_context[SharedValues::ZEALOT_QRCODE_URL]
+        }
+      end
+
+      def self.available_options
+        options = zealot_options(ZealotAction, excluding: [:file])
+        options << FastlaneCore::ConfigItem.new(
+          key: :file,
+          env_name: 'ZEALOT_FILE',
+          description: 'iOS IPA 路径，默认使用本次 gym 的产物',
+          optional: true,
+          default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH],
+          type: String,
+          verify_block: proc do |value|
+            unless File.file?(value) && File.extname(value).casecmp('.ipa').zero?
+              UI.user_error!("不是有效的 IPA 文件：#{value}")
+            end
+          end
+        )
+        options
+      end
+
+      def self.description
+        '上传 iOS IPA 到 Zealot，返回应用、版本和下载地址'
+      end
+
+      def self.example_code
+        ['upload_zealot(file: "./App.ipa", changelog: "iOS 更新说明")']
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/fastci/actions/upload_zealot_dsym_action.rb

@@ -0,0 +1,63 @@
+require 'fastlane/plugin/fastci/helper/fastci_zealot_helper'
+
+module Fastlane
+  module Actions
+    # 固定走官方 iOS dSYM 流程，不暴露 Android 或 macOS 参数。
+    class UploadZealotDsymAction < ZealotDebugFileAction
+      extend Fastlane::Helper::FastciZealotHelper
+
+      def self.run(params)
+        values = zealot_parameters(params)
+        validate_zealot_connection!(values)
+        values[:platform] = 'ios'
+        values[:zip_file] ||= Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH] unless values[:path]
+        values[:path] ||= Actions.lane_context[SharedValues::XCODEBUILD_ARCHIVE] unless values[:zip_file]
+
+        unless values[:zip_file] || values[:path]
+          UI.user_error!('请指定 dSYM zip_file、xcarchive path，或先执行 gym/package')
+        end
+
+        if values[:zip_file] && !File.file?(values[:zip_file])
+          UI.user_error!("dSYM 压缩文件不存在：#{values[:zip_file]}")
+        end
+        if values[:path] && !File.directory?(values[:path])
+          UI.user_error!("Xcode archive 不存在：#{values[:path]}")
+        end
+
+        Actions.lane_context.delete(SharedValues::ZEAALOT_ERROR_MESSAGE)
+        super(FastlaneCore::Configuration.create(ZealotDebugFileAction.available_options, values))
+      end
+
+      # 上游只检查响应中的 error 字段；非成功 HTTP 状态不能计为上传成功。
+      def self.parse_response(response, upload_url, fail_on_error)
+        return unless response
+
+        unless response.success? && response.body.is_a?(Hash)
+          return show_error("Zealot dSYM 上传失败（HTTP #{response.status}）", fail_on_error)
+        end
+
+        super
+      end
+      private_class_method :parse_response
+
+      def self.available_options
+        zealot_options(
+          ZealotDebugFileAction,
+          excluding: [:platform, :android_build_type, :android_flavor]
+        )
+      end
+
+      def self.description
+        '上传 iOS dSYM 到 Zealot，支持 zip_file、xcarchive 或本次 gym 产物'
+      end
+
+      def self.example_code
+        ['upload_zealot_dsym(zip_file: "./App.app.dSYM.zip")']
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/fastci/helper/environment.rb

@@ -91,6 +91,17 @@ module Fastlane
         ENV['FIR_SWITCH_QINIU'] == "true"
       end
 
+      # Zealot 配置；可选上传渠道，未配置时不影响现有打包流程。
+      def self.zealot_endpoint
+        ENV['ZEALOT_ENDPOINT']
+      end
+      def self.zealot_token
+        ENV['ZEALOT_TOKEN']
+      end
+      def self.zealot_channel_key
+        ENV['ZEALOT_CHANNEL_KEY']
+      end
+
       # 钉钉配置
       def self.dingdingToken
         ENV['DINGDING_TOKEN']
@@ -112,4 +123,4 @@ module Fastlane
 
     end
   end
-end
+end

data/lib/fastlane/plugin/fastci/helper/fastci_zealot_helper.rb

@@ -0,0 +1,51 @@
+require 'fastlane/plugin/zealot'
+
+module Fastlane
+  module Helper
+    # 复用官方 Action 的协议与参数，仅收口 FastCI 的 iOS 边界和日志脱敏。
+    module FastciZealotHelper
+      def zealot_options(action, excluding: [])
+        options = action.available_options.reject do |option|
+          excluding.include?(option.key) || option.key == :fail_on_error
+        end
+
+        # 新增上传渠道默认明确报错，避免 CI 把失败当作上传完成。
+        options << FastlaneCore::ConfigItem.new(
+          key: :fail_on_error,
+          env_name: 'ZEALOT_FAIL_ON_ERROR',
+          description: 'Zealot 请求失败时终止当前任务',
+          optional: true,
+          default_value: true,
+          type: Boolean
+        )
+        options
+      end
+
+      def zealot_parameters(params)
+        params.all_keys.each_with_object({}) do |key, values|
+          value = params[key]
+          values[key] = value unless value.nil?
+        end
+      end
+
+      def validate_zealot_connection!(values)
+        keys = [:endpoint, :token]
+        keys << :channel_key if values.key?(:channel_key)
+        keys.each do |key|
+          UI.user_error!("缺少 Zealot #{key}") if values[key].to_s.strip.empty?
+        end
+      end
+
+      # 官方部分 Action 未隐藏 token；只改变当前封装的输出，不修改上游全局实现。
+      def print_table(form, title: 'zealot', hidden_keys: [], remove_empty_value: true)
+        super(
+          form,
+          title: title,
+          hidden_keys: hidden_keys + [:token, :Token],
+          remove_empty_value: remove_empty_value
+        )
+      end
+
+    end
+  end
+end

data/lib/fastlane/plugin/fastci/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Fastci
-    VERSION = "0.0.20"
+    VERSION = "0.0.30"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-fastci
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.30
 platform: ruby
 authors:
 - watermelon
@@ -65,6 +65,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.5.1
+- !ruby/object:Gem::Dependency
+  name: fastlane-plugin-zealot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 email: watermelon_lp@163.com
 executables: []
 extensions: []
@@ -74,6 +88,7 @@ files:
 - README.md
 - lib/fastlane/plugin/fastci.rb
 - lib/fastlane/plugin/fastci/actions/analyze_swiftlint_action.rb
+- lib/fastlane/plugin/fastci/actions/check_zealot_version_action.rb
 - lib/fastlane/plugin/fastci/actions/detect_duplicity_code_action.rb
 - lib/fastlane/plugin/fastci/actions/detect_unused_code_action.rb
 - lib/fastlane/plugin/fastci/actions/detect_unused_image_action.rb
@@ -81,14 +96,18 @@ files:
 - lib/fastlane/plugin/fastci/actions/install_profile_action.rb
 - lib/fastlane/plugin/fastci/actions/package_action.rb
 - lib/fastlane/plugin/fastci/actions/sentry_upload_dsym.rb
+- lib/fastlane/plugin/fastci/actions/sync_zealot_devices_action.rb
 - lib/fastlane/plugin/fastci/actions/update_build_number_action.rb
 - lib/fastlane/plugin/fastci/actions/upload_fir_action.rb
 - lib/fastlane/plugin/fastci/actions/upload_pgy_action.rb
 - lib/fastlane/plugin/fastci/actions/upload_store_action.rb
+- lib/fastlane/plugin/fastci/actions/upload_zealot_action.rb
+- lib/fastlane/plugin/fastci/actions/upload_zealot_dsym_action.rb
 - lib/fastlane/plugin/fastci/helper/common_helper.rb
 - lib/fastlane/plugin/fastci/helper/constants.rb
 - lib/fastlane/plugin/fastci/helper/dingding_helper.rb
 - lib/fastlane/plugin/fastci/helper/environment.rb
+- lib/fastlane/plugin/fastci/helper/fastci_zealot_helper.rb
 - lib/fastlane/plugin/fastci/helper/fir_helper.rb
 - lib/fastlane/plugin/fastci/version.rb
 - lib/fastlane/plugin/python/generate_duplicity_code_html.py
@@ -114,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.23
 specification_version: 4
 summary: supports multiple functions such as packaging, uploading, and code detection.
 test_files: []