Fastlane(一):用法

前言

fastlane是一个自动化构建工具,主要包含测试、打包、发布等功能,它内部是由ruby实现的,是一款自动化很是高的脚本工具。android

1. 常规使用

使用fastlane并不复杂,多数状况下,只须要一个命令和一个Fastfile配置文件,就能使用fastlane去实现一些功能,好比签名、测试、打包等 下面是一个Fastfile文件中的代码,它的做用是打包程序。ios

default_platform :ios

lane :build do
    gym(export_method: 'enterprise')
end
复制代码

有了这个Fastfile文件以后,只须要在终端中执行cd project_path进入到项目主目录,而后执行fastlane build,fastlane就会开始自动打包。固然,想要执行成功,那还须要提早把全部证书都配置正确了。xcode

在使用fastlane时,通常分为两步:ruby

  1. 初始化
  2. 配置Fastfile

下面以这两步分别来说解如何使用fastlane:bash

1.1. 初始化

在使用fastlane时,通常是经过Fastfile这样的配置文件来跟它交互的,因此第一步初始化的目的是建立Fastlane文件(若是有须要,也能够建立其余类型的配置文件,如Appfile、Matchfile、Gymfile等),具体而言,就是找到项目主目录,也就是xcodeproj或xcworkspace所在的目录下,建立一个名叫fastlane或.fastlane的文件夹,在这个文件夹下,建立配置文件Fastfile。目录结构以下:并发

-test.xcodeproj
-fastlane
  -Fastfile
  -Appfile
复制代码

除了手动建立,fastlane也提供一个命令来简化这个过程app

fastlane init
复制代码

1.2. 配置Fastfile

配置Fastfile主要是在其内部建立各类lane,这些lane的做用就是帮助你达到某一种目的,好比你可能有一个叫作appstore的lane,用来发布app到appstore的lane;或者一个叫作adhoc的类,用来发布测试版本,等等,下面的例子中定义一个名叫build的lane,咱们对它的指望打包app。工具

default_platform :ios

lane :build do
end
复制代码

若是如今执行fastlane build,app并不会被打包,由于lane自己并无任何具体的功能,它的做用是绑定各类具备特定功能的action,让这些action顺序执行。 那么,为了达到打包app的做用,须要在这个lane内部添加一个具备打包功能的action,好比gym,代码以下:测试

default_platform :ios

lane :build do
    gym(export_method: 'enterprise')
end
复制代码

到目前为止,一个简单的Fastfile文件就配置完了,而后你能够先测试一下,首先须要把证书设置好,而后在终端执行cd project_path进入项目主目录,执行fastlane build,若是一切顺利,打包完成后你会在项目主目录获得一个ipa文件。网站

2. switch lane

switch lane 指的是在一个lane中调用另外一个lane

default_platform :ios

lane :lane1 do
    puts "lane1"
    lane2
end 
    
lane :lane2 do
    puts "lane2"
end 
复制代码

例子中,lane1方法中调用了lane2,执行fastlane lane1,部分输出以下

[✔] 🚀 
[16:09:47]: Driving the lane 'lane1' 🚀
[16:09:47]: --------------------------------------
[16:09:47]: --- Step: Switch to lane2 lane ---
[16:09:47]: --------------------------------------
[16:09:47]: Cruising over to lane 'lane2' 🚖
[16:09:47]: Cruising back to lane 'lane1' 🚘
[16:09:47]: 
lane1
lane2
复制代码

能够看出,执行是成功的,这说明fastlane支持lane之间相互调用。 不过,在fastlane中,并非全部lane都能相互调用,须要知足下面两个条件之一:

  1. 两个lane同属于同一个platform
  2. 被调用的lane不属于任何platform

那么,platform又是什么?

3. platform

首先,了解一下platform如何使用,Fastfile的内容以下:

platform :ios do
    lane :lane1 do
        puts "lane1"
    end 
    
    lane :lane2 do
        puts "lane2"
    end 
end
复制代码

在这个例子中,设置了两个lane,名称分别是lane1和lane2,这两个lane被一个叫作ios的platform包围。

platform的做用和lane的做用相似,lane的做用是绑定多个action,而platform则是绑定多个lane。 因为fastlane目前能够在iOS、android和Mac这三个平台使用,因此可能在同一个Fastfile中存在不一样平台的lane,使用platform可使得lane的使用范围更加明确。还有一个须要注意的是,正如上一节所说的,属于不一样platform的lane,不能相互调用

若是须要在Android端使用fastlane,则能够额外添加一个叫作:android的platform。另外,也能够在platform以外添加lane,这种lane叫作通用lane,能够被全部的lane调用。

代码以下:

lane :lane0 do
    puts "\nlane0"
end

platform :ios do
    lane :lane1 do
        puts "\nlane1"
    end 
    
    lane :lane2 do
        puts "\nlane2"
    end 
end

platform :android do
    lane :lane3 do
        puts "\nlane3"
    end 
    
    lane :lane4 do
        puts "\nlane4"
    end 
end
复制代码

这个时候,若是在终端执行fastlane lane1,fastlane会告诉你它找不到lane1

[!] Could not find 'lane1'. Available lanes: lane0, ios lane1, ios lane2, android lane3, android lane4
复制代码

可是,fastlane在错误信息里面指出可用的lanes有这些:lane0, ios lane1, ios lane2, android lane3, android lane4,那么不妨尝试一下,执行fastlane ios lane1

[✔] 🚀 
[16:21:29]: Driving the lane 'ios lane1' 🚀
[16:21:29]: 
lane1
[16:21:29]: fastlane.tools finished successfully 🎉
复制代码

成功了

通过屡次试验,能够发现当lane被定义在platform以内时,须要使用相似fastlane platform_name lane_name的命令结构来调用,好比调用lane1,则须要执行fastlane ios lane1;调用lane3,则须要执行fastlane android lane3;对于定义在platform以外的lane0,能够直接执行fastlane lane0

4.default_platform

在实际使用中,不多有人会去执行带platform的命令,通常是执行命令fastlane lane_name,这是由于fastlane还提供了另外一个方法:default_platform

default_platform :ios

lane :lane0 do
    puts "\nlane0"
end

platform :ios do
    lane :lane1 do
        puts "\nlane1"
    end 
    
    lane :lane2 do
        puts "\nlane2"
    end 
end

platform :android do
    lane :lane3 do
        puts "\nlane3"
    end 
    
    lane :lane4 do
        puts "\nlane4"
    end 
end
复制代码

如今,在这个例子中,执行fastlane lane1也能够成功调用lane1。这是由于上面的例子中在设置了默认platform

default_platform :ios
复制代码

5. action

action能够看做是fastlane中的功能模块,每个action都有其特定的功能,它规定了功能的具体实现。好比以前例子中的gym就是action,它是被用来打包工程的。

在fastlane中,内置了一系列的action,官方文档中将这些内置的action分为了如下几大类:

这里以cert这个action做为例子,来简单了解action通常如何使用。 Fastfile中的代码以下

default_platform :ios

platform :ios do
    lane :get_cert do
        cert(username: your_apple_id_username, development:false)
    end
end
复制代码

如上述代码所示,只要使用相似action_name(options)的格式就能执行指定的action,其中options是一个Hash类型的值,因此也能写成相似action_name(key1:value1,key2:value2)的格式。

使用fastlane get_cert执行上述代码,fastlane会使用your_apple_id_username登陆到苹果开发者网站查询证书信息,若是本地钥匙链中没有安装此帐号对应证书,则fastlane会尝试建立一个新的证书,若是建立成功,fastlane会下载此证书并安装到钥匙链中,同时你也会获得对应的CSR文件、证书文件和其私钥。 除此之外,cert这个action中有不少option可被设置,具体可执行fastlane action cert进行查询。

6. 加载外部action

除了使用fastlane内置的action之外,还能够建立一些自定义action,并加载到fastlane中做为外部action。 当须要为fastlane添加一些外部action时,只须要将这些自定义的action文件放在fastlane/actions/路径下便可,fastlane会自动加载。 具体目录结构以下:

-test.xcodeproj
-fastlane
  -Fastfile
  -Appfile
  -actions
    -your_action1.rb
    -your_action2.rb
复制代码

在Fastfile配置文件中,内置的action和外部action的用法一致。

7. 加载plugin

plugin是什么? plugin实质上就是由一些action组成的,并且在加载到fastlane以后,这些action和其余action没有什么区别,使用方法彻底一致。

plugin和外部action的区别? 若是你写了一些自定义的action,想分享给其余人使用,因而你提了一个PR给fastlane,可是fastlane因为一些缘由没有接受。这个时候你还有一条路可走,那就是建立一个包含这些action的plugin,并发布到RubyGems上。

这里以加载fastlane-plugin-versioning为例,在fastlane/或fastlane/../路径下执行fastlane add_plugin versioning便可,接下来你就能在Fastfile中使用这个plugin中包含的action了。

fastlane add_plugin plugin_name的执行结果是在fastlane/路径下建立文件Pluginfile,并修改Gemfile的内容,如下是执行命令以后Pluginfile和Gemfile中的内容。

Pluginfile中内容以下:

# Autogenerated by fastlane
#
# Ensure this file is checked in to source control!

gem 'fastlane-plugin-versioning'

复制代码

Gemfile中内容以下

# Autogenerated by fastlane
#
# Ensure this file is checked in to source control!

source "https://rubygems.org"

gem 'fastlane'

plugins_path = File.join(File.dirname(__FILE__), 'fastlane', 'Pluginfile')
eval_gemfile(plugins_path) if File.exist?(plugins_path)

复制代码
相关文章
相关标签/搜索