IOS工程自动打包并发布脚本实现

柔光的暖阳◎ 2023-10-17 08:28 161阅读 0赞

作者：webfrogs

转载请注明出处。

#### 前言 ####

--------------------

IOS的开发过程中，当需要给测试人员发布测试包的时候，直接使用xcode来做的效率是非常低下的。尤其是当有一点小改动需要重新出包时，那简直是个折磨的人的工作。通过一番研究后，遂决定写一系列脚本，以代替人工完成打包和发布的过程。

目前脚本已经完成，基本可以满足我目前的需求。现将其开源，托管在github上，项目地址：[点击这里][Link 1]

#### 思路 ####

--------------------

借助xcode所附带的“Command Line Tools”，可以通过命令行来完成IOS工程的编译和打包工作。脚本正是基于此完成的。

本套脚本分为三个部分：负责编译工程并打包的脚本ipa-build，负责生成itms-services协议文件的脚本ipa-publish，以及负责将ipa-publish脚本生成文件上传到服务器的脚本upload。

其中，由于我自己的情况是服务器端的同事给我了内部测试服务器的sftp的上传权限，所以这个upload脚本主要实现了使用sftp来上传的功能。具体可以实际情况来做修改。

关于itms-services协议的一些内容，可以参考我之前的文章:[《shell脚本实现ipa一键安装(itms-services协议)》][shell_ipa_itms-services]

注意：默认安装完的xcode并没有自带“Command Line Tools”，需要在xcode中选择后下载才能使用

#### 实现 ####

--------------------

打开工程后，会发现本套脚本中包含好几个shell文件。下面对其功能做说明：

ipa-build:  编译xcode工程并生成ipa文件
    ipa-publish: 生成符合itms-services协议的文件，并发布到服务器。
    sendEmail:  stmp发送email的脚本。（别人写的）
    sftpDownloadFile: 通过sftp协议下载文件
    sftpUploadFile: 通过sftp协议上传文件
    updateLocalIndexHtml:   对索引文件进行处理(二进制文件，非shell脚本)
    uploadItemsServicesFiles:   将itms-services协议文件上传到服务器

实际使用的脚本，只有"ipa-build"和"ipa-publish"这两个。其他文件会被ipa-publish这个脚本调用的依赖文件。其中出 了"updateLocalIndexHtml"是我用objc写的一个用来进行文本处理的编译后的二进制文件，其余均为shell脚本。

shell脚本实现，大家可以打开脚本来看一下，里面的注释算是很详细了。不需要太多说明。

其中值得一提的就是我在写sftp协议上传功能的时候，碰到了一个问题就是使用脚本来自动输入密码，也就是交互式脚本的编写。最后选择了expect来完成，因为我发现mac系统里自带了这个expect命令。

#### 使用 ####

--------------------

在编写脚本时，我已经考虑到，要尽量使这个脚本使用起来简单方便。如果只需要打包，那么只使用ipa-build脚本即可。如果需要用itms- services协议来发布，则再运行ipa-publish脚本即可。在ipa-publish脚本中调用了upload脚本，所以upload脚本不 需要单独使用。

ipa-build脚本使用方法：

ipa-build脚本绝对路径 参数1 参数2

其中，参数1是IOS工程的根路径,是必输项。参数2可以不输入，是可选的，含义是编译时的工程configuration类型，有4种类型可选：Debug, AdHoc,Release， Distribution。默认是Release。

ipa-build脚本运行后，会在IOS工程根路径下生成名为“build”的文件夹，在这个文件夹中又有一个名为“ipa-build”的文件夹，打包所生成的最新ipa包就在其中。

ipa-publish脚本使用方法:

ipa-publish脚本绝对路径 参数1 参数2

参数1是IOS工程的根路径,是必输项。参数2是可选的，含义是当上传文件成功后是否发送email通知，y为发送，n为不发送，默认的值是不发送。

### 1.compile and package xcode project or workspace ###

You can do this by using "ipa-build" shell script.

This ipa-build script is created to compile the xcode project and package the project to an ipa file.

##### Usage: #####

***building xcode project***

ipa-build <project directory> [-c <project configuration>] [-o <ipa output directory>] [-t <target name>] [-n]

***building xcode workspace***

ipa-build  <workspace directory> -w -s <schemeName> [-c <project configuration>] [-n]

##### Options: #####

-c NAME     the configuration of project used to compile.Default is Release
    -o PATH     output path for ipa file(must be a directory)
    -t NAME     the target which should be compiled
    -w          build xcode workspace   
    -s NAME     the schemal to be used for compiling
    -n          clean the project before compling

##### Example: #####

***build project***

If you have an iOS project in the path ~/iphone, and the ipa-build script is put in the path ~/xcode-shell.You want to build this project with 'Release' configuration.Just using script like this:

cd ~/iphone
    ~/xcode-shell/ipa-build .

If you want to assign specific configuration or target, you can add relevant options to the command.

***build workspace***

If ~/iphone is a xcode workspace and the scheme used for compile named 'test'.The ipa-build script is put in the path ~/xcode-shell.Using script like this:

cd ~/iphone
    ~/xcode-shell/ipa-build . -w -s test

You can also assign a specific configuration by using -c option.

Note:If script executed successfully,an ipa file is created in the path: <project path>/build/ipa-build.

### 2.compile project used CocoaPods ###

[CocoaPods][] is an Objective-C library manager.If you use it in your iOS project.You can also use 'ipa-build' script to build by assign workspace and scheme, or you can use the 'cocoapods-build' to build it more easily.

##### Usage: #####

cocoapods-build <cococapods project path> [<build configuration>]

##### Example: #####

cd ~/iphone
    ~/xcode-shell/cocoapods-build . Debug

### 3.publish project ###

#### ipa-publish ####

##### Configure #####

You must configure the script before using at the first time. Open it in any text editor and input you own configurations. Such as ftp address, app download url, email sender and email receiver. After that you can run this script to publish app to your own server. Note that installing app from your own server should respect the protocol named "itms-services". To learn more about "itms-services" you can click blog[Wireless AdHoc Distribution][](English) or blog[ios实现itms-services协议企业内发布或者越狱发布][ios_itms-services](中文).

##### Usage: #####

ipa-publish <project root path> [y <should send notification email>]

##### Examples: #####

~/xcode-shell/ipa-publish . y   #publish and send email
    ~/xcode-shell/ipa-publish .     #just publish

#### ipa-publish-fir ####

This script is similar to "ipa-publish". Both of them are using to publish app to somewhere. But this script will publish app to[fir.im][]. So it is more easier to use, as you don't need a special server and FTP. You can use it without any configration, unless you want to send email to notify somebody.

##### Configure #####

If you want to send email to notify somebody. Open the script, and changed the value of "email\_reciver". This field may contain one or more than one emails.

##### Usage: #####

ipa-publish-fir [-d directory>] [-e] [-l number] [-m message]

##### Options: #####

-d path     the root directory of project
    -e          send email after publishing
    -l number   limit of git log, which will be used as change log.
    -m message  used as chang log

##### Examples: #####

~/xcode-shell/ipa-publish-fir -d . -el20 -m "haha"  #Publish and send email. The change log on fir and in email will be "haha"+<last 20 logs of git>
    ~/xcode-shell/ipa-publish-fir -d .              #just publish

### 4.add @2x suffix to image files ###

When programming for retina device of iOS,the image file you used should add the suffix of @2x. Using the script "add2x" can help you do this automaticly.

**add2x**: add suffix of @2x to all the image files(just png and jpg file) .This script work in the current directory.

Usage:  
1. go to the directory which contains images should be added suffix.  
2. execute the add2x script.

**note**: There is a bug of this script.If your image file name contains blank spaces, script can not work correctly.

ipa-publish脚本运行后，会在“build”文件夹中生成一个以工程的targetname为名字的文件夹。其中，存放了itms-services协议所需的所有文件。脚本会将里面内容全部上传到服务器中。

#### 注意事项 ####

--------------------

1、运行脚本需要绝对路径，不能使用相对路径。

2、脚本下载后,若要使用，有些脚本需要一些改动。

其中ipa-build脚本无须更改。可以直接使用。ipa-publish脚本需要配置一些信息后方能正常使用。

用文本打开ipa-publish脚本后，在shell开始的地方，有一段需要配置的地方，如下：

#须配置内容  start
    
    #sftp参数设置
    sftp_server=192.168.xx.xx
    sftp_username=xx
    sftp_password=xx
    sftp_workpath="/usr/share/xx/xx/xx"
    
    #发布应用的url地址
    pulish_url="http://xx.com/xx"
    
    #以下是邮箱的相关设置
    #收件人
    email_reciver=xx@xx.com
    #发送者邮箱
    email_sender=xx@xx.com
    #邮箱用户名
    email_username=xx
    #邮箱密码
    email_password=xx
    #smtp服务器地址
    email_smtphost=smtp.exmail.qq.com
    
    
    #可配置内容  end

根据实际情况配置即可。

原文地址： [http://webfrogs.me/2013/02/18/ios-automation/][http_webfrogs.me_2013_02_18_ios-automation]

[Link 1]: https://github.com/webfrogs/xcode_shell
[shell_ipa_itms-services]: http://webfrogs.me/2012/09/27/ipapublsh/
[CocoaPods]: https://github.com/CocoaPods/CocoaPods
[Wireless AdHoc Distribution]: http://gknops.github.io/adHocGenerate/
[ios_itms-services]: http://blog.csdn.net/wyq5119275/article/details/16946009
[fir.im]: http://fir.im
[http_webfrogs.me_2013_02_18_ios-automation]: http://webfrogs.me/2013/02/18/ios-automation/