fastlane-plugin-fastci 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8e578e3c451bc288f338c816bf12606c4a2029ff4cdc77c3489950e1bb5e3d5
-  data.tar.gz: 194ee9f107f474ba5713ac7640929fe981a12cc4f8cbbbbc75018e4afe83fb3e
+  metadata.gz: 53ec20d0f578e7220c03e65b98d1ca1907f40d4bdd973fd5bba59fa17870ef20
+  data.tar.gz: fe1eb5138294dc9e4a6130b57ed96074f1c0981a344b8272a5d758e9c9edfb74
 SHA512:
-  metadata.gz: 6eb4857f9e13960b13383e52516045bb6f73db9625e419e56279cbbb0e7be4be384c70bc81378cb4c2f13b9485781074c8e27f301f720675a85e39925c14fc09
-  data.tar.gz: 490f206f40a2ebaf94b80cab887d1c12d6a229640577c7aa2605c57c4c4969ff2e7e950dd0291e063ecd3968af1d04d34be0f83e35287f5c23b1836883992d7b
+  metadata.gz: f20bf4ddf3b51247b7e7be24ecadda56acb86f10232641db6d2033bcb363c084d121ddec80f92206b3c9d5a3c882273583b62b2f045df05cbfd2efc3a4e230ae
+  data.tar.gz: 9a6feee1d0e97c4147bc41d65f3c57330e91d972246a08577e583706114730574bce1b34a55d21a46288954da1263f55bf09ffbf38da46c8bf20287190c010df

data/README.md

@@ -1,23 +1,119 @@
-# fastci plugin
 
-[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-ld)
+# fastlane-plugin-fastci
 
-## Getting Started
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-fastci)
 
-This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-ld`, add it to your project by running:
+一个集成 iOS CI 与多种自动化操作的 Fastlane 集合插件。
+简单快速的集成，5 分钟即可上手。
+配合 Jenkins 实现高度自定义。
 
-```bash
-fastlane add_plugin fastci
+目前还在 Beta 测试阶段！！！
+
+---
+
+## 安装方法
+
+1、安装 [python3](https://www.python.org/downloads/macos/)
+
+2、安装 [homebrew](https://brew.sh/)
+
+3、安装并初始化 [fastlane](https://docs.fastlane.tools/getting-started/ios/setup/)
+
+4、添加插件 ` fastlane add_plugin fastci `
+
+5、更新插件 ` fastlane update_plugins `
+
+---
+
+## 使用方法
+
+参考 [` Fastfile `](fastlane/Fastfile) 和 [` .env.default `](fastlane/.env.default) 替换项目内 fastlane 文件夹下文件。
+然后终端进入项目根目录就可以使用 ` fastlane `
+
+
+### 使用后会在项目根目录生成文件夹
+
+可以自行在 ` .gitignore ` 中设置忽略等级 
+
+```
+fastlane_cache/ # 插件缓存文件夹
+├── build_logs/ # 编译日志
+├── html/ # 各种检查报告
+├── temp/ # 临时文件
+├── build_cache.txt # build 自动递增缓存
+└── commit_cache.txt # git commit 缓存
+```
+
+## 支持功能与使用示例
+
+### 1. 自动打包
+功能：自动编译并导出 ipa 包，支持多种打包方式和集成多项检查。
+生成完的 ipa 会放在桌面上，非 ` app-store ` 配置了蒲公英或 fir 参数会自动上传蒲公英或 fir` app-store ` 配置了商店参数会自动上传商店。
+
+` build `: 不指定的话内部有递增逻辑，格式为 ` 20250905.15（日期+当天包的次数） `
+
+` version `: 在 Xcode13 之后创建的项目，不再支持脚本修改。需要兼容请在 ` Build settings ` 中将 ` GENERATE_INFOPLIST_FILE ` 设置为 ` NO `
+
+```ruby
+package(
+	configuration: "Debug", # 编译环境 Release/Debug
+	export_method: "development", # 打包方式 ad-hoc, enterprise, app-store, development
+	version: nil, # 指定 version
+	build: nil, # 指定 build 号
+	is_analyze_swiftlint: false, # 是否代码分析
+	is_detect_duplicity_code: false, # 是否检测重复代码
+	is_detect_unused_code: false, # 是否检测未使用代码
+	is_detect_unused_image: false # 是否检测未使用图片
+    release_notes: options[:release_notes] # 配合 jenkins 传参上传 appstore { "zh-Hans" => "修复问题", "en-US" => "bugfix"} 格式   
+)
+```
+
+### 2. SwiftLint 静态代码分析
+功能：依赖 ` SwiftLint ` 对项目代码进行静态分析，生成分析报告。
+使用前需要参考自定义 [` .swiftlint.yml `](/.swiftlint.yml) 文件，并将该文件放到项目根目录。
+
+` commit_hash `: 上一次提交哈希, 会比较该哈希到最新哈希之间的文件
+
+```ruby
+analyze_swiftlint(
+	is_all: true, # 是否检查所有文件，默认 true
+	configuration: "Debug", # 构建配置，Debug/Release
+	commit_hash: nil # 指定 commit hash，仅检查变更文件
+)
+```
+
+### 3. 检测重复代码
+功能：检测项目中的重复代码，生成分析报告。
+使用前需要参考自定义 [` .periphery.yml `](/.periphery.yml) 文件，并将该文件放到项目根目录。
+
+` commit_hash `: 上一次提交哈希, 会比较该哈希到最新哈希之间的文件
+
+```ruby
+detect_duplicity_code(
+	is_all: true, # 是否检查所有文件，默认 true
+	commit_hash: nil # 指定 commit hash，仅检查变更文件
+)
 ```
 
-## About fastci
+### 4. 检测未使用代码
+功能：检测项目中未被使用的代码，生成分析报告。
+默认只支持 ` Debug `，需要支持 ` Release ` 请在 ` Build settings ` 中将 ` Enable Index-While-Building Functionality ` 设置为 ` Yes `。
+
+```ruby
+detect_unused_code(
+	configuration: "Debug" # 构建配置，Debug/Release
+)
+```
 
-这个插件集成了打包、上传 appstore、上传蒲公英、钉钉通知、无用图片检测、无用代码检测、重复代码检测、swiftlint 代码检测
+### 5. 检测未使用图片资源
+功能：检测项目中未被使用的图片资源，生成分析报告。
 
-## Example
+```ruby
+detect_unused_image()
+```
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+---
 
-## About _fastlane_
+## 贡献与支持
 
-_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
+如需更多帮助或贡献，请提交 Issue 或 PR。

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

@@ -8,10 +8,10 @@ module Fastlane
       def self.run(params)
         UI.message("*************| 开始安装 p12 证书 |*************")
 
-        certificate_paths = Dir.glob("../#{Environment.certificate_folder_name}/*.p12")
+        certificate_paths = Dir.glob(File.expand_path("#{Environment.certificate_folder_name}/*.p12"))
         certificate_paths.each do |path|
-          import_certificate(
-            certificate_path: File.expand_path(path),
+          other_action.import_certificate(
+            certificate_path: path,
             certificate_password: "#{Environment.certificate_password}",
             keychain_name: "login.keychain",
             keychain_password: "#{Environment.keychain_password}"

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

@@ -7,11 +7,11 @@ module Fastlane
     class InstallProfileAction < Action
       def self.run(params)
         UI.message("*************| 开始安装 provisioningProfile |*************")
-
-        provisioning_profile_paths = Dir.glob("../#{Environment.provisioningProfile_folder_name}/*.mobileprovision")
+        
+        provisioning_profile_paths = Dir.glob(File.expand_path("#{Environment.provisioningProfile_folder_name}/*.mobileprovision"))
         provisioning_profile_paths.each do |path|
-          install_provisioning_profile(
-            path: File.expand_path(path)
+          other_action.install_provisioning_profile(
+            path: path
           )
         end
       end

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

@@ -27,9 +27,9 @@ module Fastlane
         FileUtils.rm_rf(Dir.glob("#{Constants.IPA_OUTPUT_DIR}/*"))
         
         # 安装证书
-        InstallCertificateAction.run({})
+        other_action.install_certificate()
         # 安装 provisioningProfile
-        InstallProfileAction.run({})
+        other_action.install_profile()
 
         scheme = Environment.scheme
 
@@ -115,27 +115,39 @@ module Fastlane
 
         if export_method == "app-store"
           notiText = "🚀🚀🚀🚀🚀🚀\n\n#{scheme}-iOS-打包完成\n\n#{version}_#{build}_#{export_method}\n\n🚀🚀🚀🚀🚀🚀"
-          NotiDingdingAction.run(notiText: notiText)
+          DingdingHelper.sendMarkdown(notiText)
 
           if CommonHelper.is_validate_string(Environment.connect_key_id) && CommonHelper.is_validate_string(Environment.connect_issuer_id)
 
-            UploadStoreAction.run({})
+            other_action.upload_store()
             notiText = "🚀🚀🚀🚀🚀🚀\n\n#{scheme}-iOS-上传完成\n\n#{version}_#{build}_#{export_method}\n\n🚀🚀🚀🚀🚀🚀"
-            NotiDingdingAction.run(notiText: notiText)
+            DingdingHelper.sendMarkdown(notiText)
           end
         else
-          # 上传蒲公英
-          pgy_upload_info = UploadPgyAction.run(
-            "ipa_path": ipa_path
-          )
-          qrCode = pgy_upload_info["buildQRCodeURL"]
-
           # 钉钉通知
           notiText = "🚀🚀🚀🚀🚀🚀\n\n#{scheme}-iOS-打包完成\n\n#{version}_#{build}_#{export_method}\n\n🚀🚀🚀🚀🚀🚀"
-          if CommonHelper.is_validate_string(qrCode)
-            notiText << "\n\n⬇️⬇️⬇️ 扫码安装 ⬇️⬇️⬇️\n\n![screenshot](#{qrCode})"
+
+          # 上传蒲公英
+          if CommonHelper.is_validate_string(Environment.pgy_api_key)
+            pgy_upload_info = other_action.upload_pgy()
+            qrCode = pgy_upload_info[:buildQRCodeURL]
+
+            if CommonHelper.is_validate_string(qrCode)
+              notiText << "\n\n⬇️⬇️⬇️ 扫码安装 ⬇️⬇️⬇️\n\n\n密码: #{Environment.pgy_password}\n![screenshot](#{qrCode})"
+            end
           end
-          NotiDingdingAction.run(notiText: notiText)
+
+          # 上传 fir
+          if CommonHelper.is_validate_string(Environment.fir_api_token)
+            fir_upload_info = other_action.upload_fir()
+            download_url = fir_upload_info[:download_url]
+
+            if CommonHelper.is_validate_string(download_url)
+              notiText << "\n\n⬇️⬇️⬇️ 点击链接安装 ⬇️⬇️⬇️\n\n\n密码: #{Environment.fir_password}\n[_点击下载_](#{download_url})"
+            end
+          end
+
+          DingdingHelper.sendMarkdown(notiText)
         end
 
         # 代码分析
@@ -182,13 +194,13 @@ module Fastlane
           UI.message("*************| 跳过未使用图片检查 |*************")
         end
 
-        if is_swiftlint ||
+        if is_analyze_swiftlint ||
           is_detect_duplicity_code ||
           is_detect_unused_code ||
           is_detect_unused_image
           # 钉钉通知
           notiText = "🚀🚀🚀🚀🚀🚀\n\n#{scheme}-iOS-代码检查完成\n\n#{version}_#{build}_#{export_method}\n\n🚀🚀🚀🚀🚀🚀"
-          NotiDingdingAction.run(notiText: notiText)
+          DingdingHelper.sendMarkdown(notiText)
         else
           UI.message("*************| 跳过代码检查 |*************")
         end
@@ -270,6 +282,12 @@ module Fastlane
             default_value: false,
             type: Boolean
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :release_notes,
+            description: "更新文案, 格式为 { \"zh-Hans\" => \"修复问题\", \"en-US\" => \"bugfix\"} ",
+            optional: true,
+            type: Hash
+          )
         ]
       end
 

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

@@ -0,0 +1,38 @@
+require 'fastlane/action'
+require 'fastlane/plugin/fir_cli'
+include Fastlane::Helper
+
+module Fastlane
+  module Actions
+    # 上传Fir
+    class UploadFirAction < Action
+      def self.run(params)
+        UI.message("*************| 开始上传Fir |*************")
+
+        firinfo = other_action.fir_cli(
+          api_token: Environment.fir_api_token,
+          password: Environment.fir_password,
+        )
+        
+        return firinfo
+      end
+
+      def self.description
+        "上传Fir"
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.category
+        :building
+      end
+
+    end
+  end
+end

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

@@ -9,15 +9,7 @@ module Fastlane
       def self.run(params)
         UI.message("*************| 开始上传蒲公英 |*************")
 
-        unless CommonHelper.is_validate_string(Environment.pgy_api_key)
-          UI.message("*************| 没有配置 pgy_api_key |*************")
-          return
-        end
-
-        ipa_path = params[:ipa_path] || ""
-
-        pgyinfo = PgyerAction.run(
-          ipa: ipa_path,
+        pgyinfo = other_action.pgyer(
           api_key: Environment.pgy_api_key,
           password: Environment.pgy_password,
           install_type: "2"

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

@@ -21,7 +21,7 @@ module Fastlane
           force: true,
           submit_for_review: false,
           automatic_release: false,
-          release_notes: params[:release_notes]
+          release_notes: params[:release_notes] || ""
         )
         
       end

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

@@ -41,7 +41,7 @@ module Fastlane
         "fastlane_cache/build_logs"
       end
       def self.IPA_OUTPUT_DIR
-        "fastlane_cache/build_products"
+        "fastlane_cache/temp"
       end
     end
   end

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

@@ -0,0 +1,27 @@
+require 'fastlane_core/ui/ui'
+require 'fileutils'
+
+module Fastlane
+  module Helper
+    class DingdingHelper
+
+      def self.sendMarkdown(text)
+        UI.message("*************| 开始钉钉消息通知 |*************")
+
+        curl = %Q{
+          curl 'https://oapi.dingtalk.com/robot/send?access_token=#{Environment.dingdingToken}' \
+          -H 'Content-Type:application/json' \
+          -d '{
+            "msgtype":"markdown",
+            "markdown":{
+              "title":"#{Environment.scheme} 打包通知",
+              "text":"#{text}"
+            }
+          }'
+        }
+        system curl
+      end
+
+    end
+  end
+end

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

@@ -77,6 +77,14 @@ module Fastlane
         ENV['PGY_PASSWORD']
       end
 
+      # Fir配置
+      def self.fir_api_token
+        ENV['FIR_API_TOKEN']
+      end
+      def self.fir_password
+        ENV['FIR_PASSWORD']
+      end
+
       # 钉钉配置
       def self.dingdingToken
         ENV['DINGDING_TOKEN']

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

@@ -0,0 +1,29 @@
+require 'fastlane_core/ui/ui'
+require 'fastlane/plugin/fir_cli'
+require 'fileutils'
+
+module Fastlane
+  module Helper
+    class FirHelper
+
+      # def self.get_download_url(download_domain, short)
+      #   "https://#{download_domain}/#{short}"
+      # end
+
+      # def self.get_qrcode(download_url)
+      #   filePath = File.expand_path(Constants.IPA_OUTPUT_DIR)
+      #   qrcode_path = "#{filePath}/fir-qrcode.png"
+      #   generate_rqrcode(download_url, qrcode_path)
+
+      #   qrcode_path
+      # end
+
+      # def self.generate_rqrcode(string, png_file_path)
+      #   qrcode = ::RQRCode::QRCode.new(string.to_s)
+      #   qrcode.as_png(size: 500, border_modules: 2, file: png_file_path)
+      #   png_file_path
+      # end
+
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Fastci
-    VERSION = "0.0.3"
+    VERSION = "0.0.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-fastci
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - watermelon
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: fastlane-plugin-versioning
   requirement: !ruby/object:Gem::Requirement
@@ -37,6 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: fastlane-plugin-fir_cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.21
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.21
 email: watermelon_lp@163.com
 executables: []
 extensions: []
@@ -51,14 +65,16 @@ files:
 - lib/fastlane/plugin/fastci/actions/detect_unused_image_action.rb
 - lib/fastlane/plugin/fastci/actions/install_certificate_action.rb
 - lib/fastlane/plugin/fastci/actions/install_profile_action.rb
-- lib/fastlane/plugin/fastci/actions/noti_dingding_action.rb
 - lib/fastlane/plugin/fastci/actions/package_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/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/fir_helper.rb
 - lib/fastlane/plugin/fastci/version.rb
 - lib/fastlane/plugin/python/generate_duplicity_code_html.py
 - lib/fastlane/plugin/python/generate_lint_html.py

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

@@ -1,51 +0,0 @@
-require 'fastlane/action'
-include Fastlane::Helper
-
-module Fastlane
-  module Actions
-    # 钉钉通知
-    class NotiDingdingAction < Action
-      def self.run(params)
-        UI.message("*************| 开始钉钉消息通知 |*************")
-        notiText = params[:notiText] || ""
-
-        curl = %Q{
-          curl 'https://oapi.dingtalk.com/robot/send?access_token=#{Environment.dingdingToken}' \
-          -H 'Content-Type:application/json' \
-          -d '{
-            "msgtype":"markdown",
-            "markdown":{
-              "title":"#{Environment.scheme} 打包通知",
-              "text":"#{notiText}"
-            }
-          }'
-        }
-        system curl
-      end
-
-      def self.description
-        "钉钉通知"
-      end
-
-      def self.available_options
-        [
-          FastlaneCore::ConfigItem.new(
-            key: :notiText,
-            description: "要发送的钉钉通知内容",
-            optional: false, # 是否可选
-            type: String
-          ),
-        ]
-      end
-
-      def self.is_supported?(platform)
-        platform == :ios
-      end
-
-      def self.category
-        :notifications
-      end
-
-    end
-  end
-end