iOS持续集成(三)——fastlane 自定义插件

fastlane的强大带我们不少的便利,但事无人愿。总有些不一样的需求,今天就给大家带来的是fastlaneaction和插件。

这也是fastlane精髓部分,它使fastlane具有强大扩展性,以保证变化不断的个性化需求。

自定义本地action

在项目中,可以创建自定义的action扩展fastlane的功能性。创建的这个actionfastlane内置的action在使用上面来说没多大区别。下面来个例子:

创建本地action

更新 build 版本号,格式就以年月日时分。在终端输入下面命令:

fastlane new_action

action实现分析

在后面会被要求输入action的名字,输入update_build_version按回车后,fastlane会在fastlane/actions目录下面创建后缀为.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的相关信息

image

顺便提一下要在另外的项目上使用,直接复制过去就行了。至于要提交到fastlane的官方库,还是相对来说门槛较高。

自定义插件

上面的action在共享这方面,只能靠复制这一手段,相当之不优雅。那么插件是我们最好的选择。

创建插件

进入一个新的目录

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安装插件以及需要的依赖
  • 如果之前未安装过插件,会生成三个文件:GemfileGemfile.lockfastlane/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),安装插件以及相关依赖

总结

action的出现,大大的增强了fastlane的扩展性。使我们适应自己的业务,定制所需要action。另外,Plugin使fastlane在有强大的扩展性同量,使用更加灵活。

总的来说,如果是单单的项目,action可以解决问题。如果是多个项目,使用plugins是不二选择。

小Tips:如果看不懂,去补一下Ruby的语法。还有就是多点看一下网上action和plugin写法。

参考文档:

Create Your Own Plugin(官方文档)

Available Plugins

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,688评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,559评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,749评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,581评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,741评论 3 271
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,684评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,122评论 2 292
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,847评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,441评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,939评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,333评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,783评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,275评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,830评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,444评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,553评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,618评论 2 249

推荐阅读更多精彩内容

  • fastlane运行所需要的环境: OS X 10.9以上 Ruby 2.0 以上 Xcode 拥有一个开发者账号...
    阿姣_0405阅读 2,828评论 0 4
  • 前言 最近公司有打渠道包的需求,领导说使用fastlane来做持续集成,发了点时间研究了下,所有有了这篇文章 本文...
    aron1992阅读 1,324评论 0 5
  • 持续集成指的是,频繁地(一天多次)将代码集成到主干。它的好处主要有两个。 (1)快速发现错误。每完成一点更新,就集...
    码农甲阅读 7,813评论 2 2
  • fastlane是一个自动化构建工具,主要包含测试、打包、发布等功能,它内部是由ruby实现的,是一款自动化非常高...
    wangzzzzz阅读 6,192评论 3 19
  • 思考与行动: 1.你最近脑子里冒出“有钱了不起啊?”这个念头是什么时候?针对什么事儿?针对什么人?今天反思的话,哪...
    琬如雨林阅读 156评论 0 0