iOS持續集成（三）——fastlane 自定義插件

時間 2019-11-29

標籤 ios 持續集成 fastlane 自定義插件欄目 iOS 简体版

原文原文鏈接

fastlane的強大帶咱們很多的便利，但事無人願。總有些不同的需求，今天就給你們帶來的是fastlane的action和插件。ios

這也是fastlane精髓部分，它使fastlane具備強大擴展性，以保證變化不斷的個性化需求。git

自定義本地`action`

在項目中，能夠建立自定義的action擴展fastlane的功能性。建立的這個action跟fastlane內置的action在使用上面來講沒多大區別。下面來個例子：github

建立本地`action`

更新 build 版本號，格式就以年月日時分。在終端輸入下面命令：shell

fastlane new_action
複製代碼

`action`實現分析

在後面會被要求輸入action的名字，輸入update_build_version按回車後，fastlane會在fastlane/actions目錄下面建立後綴爲.ruby文件。請看下面的文件內容ruby

module Fastlane
  module Actions
    module SharedValues
      UPDATE_BUILD_VERSION = :UPDATE_BUILD_VERSION_CUSTOM_VALUE
    end

    class UpdateBuildVersionAction < Action

      def self.run(params) # 這個方法爲Action的主方法，在這裏我們寫入更新版本號的內容
        
        if params[:version_number]
          new_version = params[:version_number]
        else 
          # 格式化時間
          new_version = Time.now.strftime("%Y%M%d")
        end

        command = "agvtool new-vresion -all #{new_version}" #使用蘋果的 agvtool 工具更新版本號 

        Actions.sh(command) #執行上面的 shell 命令
        Actions.lane_context[SharedValues::UPDATE_BUILD_VERSION] = new_version # 更新全局變量，供其餘的Actions使用
        
      end

      def self.description  # 對於該Action小於80字符的簡短描述
        "A short description with <= 80 characters of what this action does"
      end

      def self.details # 對於該Action的詳細描述
        # Optional: 可選
      end

      def self.available_options # 定義外部輸入的參數，在這裏我們定義一個指定版本號的參數
      
        [
          FastlaneCore::ConfigItem.new(key: :version_number, # run方法裏面根據該key獲取參數 
                                       env_name: "FL_UPDATE_BUILD_VERSION_VERSION_NUMBER", # 環境變量
                                       description: "Change to a specific version", # 參數簡短描述
                                       optional: true),
        ]
      end

      def self.output # 輸入值描述，若是在 run 方法更新 SharedValues 模塊裏面自定義的變量，供其餘的 Action 使用，可選
        [
          ['UPDATE_BUILD_VERSION_CUSTOM_VALUE', 'A description of what this value contains']
        ]
      end

      def self.return_value # 返回值描述, 指的 run 方法會有返回值。可選
      end

      def self.authors # 做者
        ["ChenJzzz"]
      end

      def self.is_supported?(platform) # 支持的平臺
        # you can do things like
        # 
        # true
        # 
        # platform == :ios
        # 
        # [:ios, :mac].include?(platform)
        # 

        platform == :ios
      end
    end
  end
end

複製代碼

從上面的方法上來看，主要的仍是run方法和available_options方法。若是看不懂上面的代碼，那去補一下ruby相關的語法。OK，這個action跟其餘的action同樣，在Fastlane直接使用就能夠了。在終端輸入fastlane action update_build_version，會像下面同樣，打印出action的相關信息bash

順便提一下要在另外的項目上使用，直接複製過去就好了。至於要提交到fastlane的官方庫，仍是相對來講門檻較高。工具

自定義插件

上面的action在共享這方面，只能靠複製這一手段，至關之不優雅。那麼插件是咱們最好的選擇。測試

建立插件ui

進入一個新的目錄this

fastlane new_plugin [plugin_name]
複製代碼

fastlane 建立Ruby gem庫目錄
lib/fastlane/plugin/[plugin_name]/actions/[plugin_name].rb這個文件是咱們要實現的action文件

插件跟action都是一樣的寫法。在這裏就不重複描述了。

在當前目錄下，能夠運行fastlane test，測試插件是否正確

使用方法

安裝已發佈到`RubyGems`的插件

fastlane add_plugin [name]
複製代碼

fastlane會執行如下步驟

添加插件到fastlane/Pluginfile
使./Gemfile文件正確引用fastlane/Pluginfile
運行fastlane install_plugins安裝插件以及須要的依賴
若是以前未安裝過插件，會生成三個文件：Gemfile、Gemfile.lock和fastlane/Pluginfile

安裝其餘插件

正如上面所說，在項目裏面的fastlane/Pluginfile添加下面內容

# 安裝發佈到 Github 的插件
gem "fastlane-plugin-example", git: "https://github.com/fastlane/fastlane-plugin-example"
# 安裝本地插件
gem "fastlane-plugin-xcversion", path: "../fastlane-plugin-xcversion"
複製代碼

在終端運行fastlane/Pluginfile(或者 bundle exec fastlane/Pluginfile)，安裝插件以及相關依賴