在实际项目中, 一个构建任务对应一份svn代码, 但是可以通过Jenkins的参数化构建, 实现打包时的环境切换. 这需要对我们的工程进行改造, 将环境参数和Jenkins提供的参数进行关联, 实现此功能.
通过General - 参数化构建过程的配置, 可以看到, 该配置提供了很多数据类型, 我们选用了 列表和布尔值做实例说明.
创建参数名为HOST_NAME的列表类型的参数来设置三个测试环境的切换.
再创建一个isDarkModel的布尔值类型的参数来控制测试程序的黑暗模式的开启与关闭.
参数化构建1.png
参数化构建2.png
创建好以后参数以后, 应用保存, 可以看到, 以前的立即构建变成了 Build with parameters (参数化构建) . 之前配置的 "名称"/"选项"/"描述" 均可在该页面中看到.
指的注意的是, "名称"是以后要在脚本中获取来用的, 所以一般采用英文命名, 这样一来, 用汉语将描述部分写清楚就十分有必要了, 这对使用该项目的打包的人来说会更友好.
另外, 列表在配置选项项时, 不同选项用回车换行即可. 比如该示例中, HOST_NAME 三个选项分别是 测试环境1 / 2 / 3 , 在构建时的下拉列表显示的就是这三个选项, 在以后shell脚本中可以使用$HOST_NAME来获取, 如果你选择了 "测试环境2"的选项, 那么 $HOST_NAME="测试环境2".
参数化构建3.png
那么, 如何把该这些参数传入我们的工程呢?
首先对工程做一下改造, 工程添加一下文件:
- GlobalConfig.h
- JenkinsConfig.h
- ConfigShell.sh
如图:
工程改造.png
首先, ConfigShell.sh 文件是脚本文件, 在该脚本中, 通过 $参数名称 的方式获取Jenkins中配置的打包参数, 通过判断后将得到相应的环境名写入JenkinsConfig.h 文件中. 而ConfigShell.sh 文件则负责将所有环境列出来, 通过引用JenkinsConfig.h头文件, 根据该文件的配置项, 选择性编译定义的环境变量的宏. (比如选择的是 测试环境2, 则在JenkinsConfig.h插入#define HOST_DEBUG_2, 这样GlobalConfig.h文件中引后, 便会编译HOST_DEBUG_2中定义的环境的宏)
之所以放到工程中, 而没有完全写到Jenkins的执行脚本的配置项里, 是因为我觉得这样可以让执行脚本随着svn一起管理起来, 以后开了分支也比较方便,不需要重复写.
//GlobalConfig.h
#import "JenkinsConfig.h"
//环境变量配置
//#define HOST_DEBUG
//#define HOST_DEBUG_2
//#define HOST_RELEASE
#ifndef HOST_DEBUG
#else
#define HOST @"测试环境1"
#endif
#ifndef HOST_DEBUG_2
#else
#define HOST @"测试环境2"
#endif
#ifndef HOST_RELEASE
#else
#define HOST @"发布环境"
#endif
//暗黑模式配置
//#define DarkModel
#ifndef DarkModel
#define kIsDarkModel NO
#else
#define kIsDarkModel YES
#endif
//ConfigShell.sh
#!/bin/sh
#变量1 HOST_NAME 环境切换 (list 测试环境1 | 测试环境2 | 测试环境3 )
#变量2 isDarkModel 是否暗黑模式 (BOOL 默认值 false: 不是暗黑模式 true: 暗黑模式)
echo "//环境配置注释">JenkinsConfig.h
echo "------ Jenkins_编译配置项打印日志: ------"
echo "HOST_NAME(环境切换)"
echo "//HOST_NAME(环境切换)">>JenkinsConfig.h
echo "value=测试环境1:说明..."
echo "//value=测试环境1:说明...">>JenkinsConfig.h
echo "value=测试环境2:说明..."
echo "//value=测试环境2:说明...">>JenkinsConfig.h
echo "value=测试环境3:说明..."
echo "//value=测试环境3:说明...">>JenkinsConfig.h
echo "当前配置环境:"$HOST_NAME
echo "\n">>JenkinsConfig.h
if [ $HOST_NAME = "测试环境1" ] ; then
hostConfig="#define HOST_DEBUG"
elif [ $HOST_NAME = "测试环境2" ] ; then
hostConfig="#define HOST_DEBUG_2"
elif [ $HOST_NAME = "测试环境3" ] ; then
hostConfig="#define HOST_RELEASE"
else
echo "HOST_NAME参数无效!!!"
fi
echo $hostConfig>>JenkinsConfig.h
echo "\n">>JenkinsConfig.h
echo "isDarkModel(是否启用暗黑模式)"
echo "//isDarkModel(是否启用暗黑模式)">>JenkinsConfig.h
echo "当前是否启用暗黑模式:"$isDarkModel
if [ $isDarkModel = true ] ; then
darkModel="#define DarkModel"
else
darkModel="//#define DarkModel"
fi
echo $darkModel>>JenkinsConfig.h
echo "------ Jenkins_编译配置项打印日志_end ------"
注释
$hostConfig>JenkinsConfig.h #将变量hostConfig的值写入JenkinsConfig.h文件中,覆盖该文件之前的全部内容
$hostConfig>>JenkinsConfig.h #将变量hostConfig的值写入JenkinsConfig.h文件中的最后,不会覆盖该文件之前的内容
如果用户选择了 测试环境2 和 开启暗黑模式, 可以看到JenkinsConfig.h文件的如下
//JenkinsConfig.h
//环境配置注释
//HOST_NAME(环境切换)
//value=测试环境1:说明...
//value=测试环境2:说明...
//value=测试环境3:说明...
#define HOST_DEBUG_2
//isDarkModel(是否启用暗黑模式)
#define DarkModel
可以得知, JenkinsConfig.h文件会据此, 编译 HOST_DEBUG_2 和 DarkModel两部分内容.
至此, 回到Jenkins当中去, 在构建模块中, 添加 执行shell, 添加如下脚本:
cd $WORKSPACE/JenkinsTest
sh ConfigShell.sh
注意, 该脚本需要添加在 xcode配置之前. 如图:
参数化构建4.png
至此, 回到构建页面, 选择相应的参数, 执行构建, 即可.
网友评论