macOS Jenkins安装&配置

作者: 知德 | 来源:发表于2017-03-01 12:07 被阅读11411次

    一、依赖环境

    1. JavaSDK(Java SE Development Kit)

    在终端命令行输入java -version命令,如果打印出java版本,则代表已安装,可以略过此步骤。
    如果没有安装过,进入JavaSDK官网,接受协议,选择 & 下载对应系统的 安装包

    下载完成,点击安装,安装完成再次在终端中执行上面的命令,可以看到已安装JavaSDK的版本

    2. Apache

    Mac系统自带,略过


    二、安装Jenkins

    1. 下载安装Jenkins

    方法有多种,暂以下载dmg客户端为例
    进入Jenkins官网,下载最新版本的Jenkins客户端

    双击下载好的dmg文件进行安装,其将会自动生成全局变量jenkins
    Jenkins默认安装路径:/Applications/Jenkins/jenkins.war
    (如果下载.war格式文件,将文件复制到欲安装文件夹即可)
    修改参数: jenkins + 相关参数,如
    jenkins –httpPort=8888#更换端口号,当默认端口8080被占用,或指定特定端口时。

    2. 启动Jenkins

    如果是使用dmg文件安装的,安装完成之后,会自动启动jenkins,打开浏览器,进入网页 localhost:8080

    终端命令

    设置开机自启动:sudo launchctl load -w /Library/LaunchDaemons/org.jenkins-ci.plist
    取消开机自启动:sudo launchctl unload -w /Library/LaunchDaemons/org.jenkins-ci.plist
    手动启动:Java -jar jenkins.war
    后台启动(默认端口):nohup java -jar jenkins.war &
    后台启动(指定端口):nohup java -jar jenkins.war -httpPort=88 &
    后台启动(HTTPS):nohup java -jar jenkins.war -httpsPort=88 &
    

    注:可能出现连接不到服务器的问题,原因就是Java环境有问题,重新配置Java环境即可。


    三、配置Jenkins

    1、重启电脑

    重启电脑之后,你会发现Jenkins给你的电脑新增了一个用户,名字就叫Jenkins
    打开localhost:8080,出现Unlock Jenkins(重设初始密码)界面
    密码在/Users/userName/.jenkins/secrets/initialAdminPassword**文件(下图标注红色路径)中,打开文件,复制密码填到网页密码输入框中,继续

    选择建议安装设置


    安装中


    等待Jenkins重启完成


    创建管理员账号:输入用户名、密码、邮件等


    创建完,进入Jenkins初始界面


    2、管理插件

    选择“系统管理”——“管理插件”,进入插件管理界面(可以安装、更新、卸载jenkins插件)

    • √ Git插件: Git plugin
    • √ Gitlab插件:GitLab Plugin 和 Gitlab Hook Plugin
    • ? iOS专用:Xcode integration
    • ? Android专用:Gradle plugin
    • GitBuckit插件:GitBuckit plugin
    • 签名证书管理插件:Credentials Plugin 和 Keychains and Provisioning Profiles Management
    • FTP插件:Publish over FTP
    • 脚本插件:Post-Build Script Plug-in
    • 修改Build名称/描述(二维码):build-name-setter / description setter plugin
    • 获取仓库提交的commit log:Git Changelog Plugin
    • 自定义全局变量:Environment Injector Plugin
    • 自定义邮件插件:Email Extension Plugin
    • 显示代码测试覆盖率报表:Cobertura Plugin
    • 来展示生成的单元测试报表,支持一切单测框架,如junit、nosetests等:Junit Plugin
    • 其它:SSH Credentials Plugin

    注:打√号的建议安装,? 号按系统和编辑器安装,其他 选择安装

    3、系统设置

    选择“系统管理”——“系统设置”,进入系统设置界面(可以管理全局属性、配置邮件通知)
    全局属性下面,勾选Environment variables,增加一对键值对:

    • LANG = zh_CN.UTF-8
    • PATH = (终端中执行 echo $PATH 命令的输出,为一堆路径)

    4、新建项目

    点击“新建”或者“创建一个新任务”


    输入新项目名称,选“新建一个自由风格的软件项目”


    点击新建好的项目(第一次可能不需要吧,给忘记了,反正下一步是配置)


    5、配置项目

    点击“配置”


    进入配置界面,配置项目参数

    A. General配置

    注:这里可以设置包(构建)的保留天数和保留的最大个数

    B. 源码管理

    由于现在我用到的是GitLab,先配置SSH Key

    创建SSH证书:

    • 终端执行:ssh-keygen -t rsa -C "xxx@xxx.com"(邮箱)
    • 按回车保存到默认位置,再稍等出来提示输入passphrase密码短语,输完按回车要输两遍(它是用来加密私钥,也就是以后使用私钥的时候要输这个密码,如果输入,就需要记住,或者直接置空)
    • 创建成功的SSH 默认路径为 ~/.ssh 目录
    • id_rsa 文件存储密钥 ,id_rsa.pub存储公钥

    添加SSH证书:

    • 在Jenkins管理页面,点击“Credentials”后的Add按钮
    • Domain 选择 “Global credentials (unrestricted)”
    • Kind 选择 “SSH Username with private key”,如下图所示
    • Username 随意,自己可看懂的标识
    • 复制id_rsa中的字符串到private key中,passphrase为创建SSH时,填写的passphrase秘密(如果为空,则直接设置为空)
    • 点击“Add”,把SSH添加到Jenkins中

    配置SSH也可以参考配置Git代码仓库

    然后在“Credentials”处选择刚添加的那个SSH配置。
    如果配置正确的话,是不会出现下图中的那段红色的警告。如果有下图的提示,就说明Jenkins还没有连通GitLab或者SVN,那就请再检查SSH Key是否配置正确。


    C. 构建触发器

    构建触发器设置这里是设置自动化测试的地方。这里涉及的内容很多,暂时没有深入研究,有自动化测试需求的可以好好研究研究这里的设置。

    • Build when a change is pushed to GitHub
      当有数据推送到远程库中时构建
    • Poll SCM (poll source code management)
      轮询源码管理
      需要设置源码的路径才能起到轮询的效果。一般设置为类似结果: H/5 * * * * 每5分钟轮询一次
    • Build periodically (定时build)
      一般设置为类似: 00 20 * * * 每天 20点执行定时build

    格式如下

    分钟(0-59) 小时(0-23) 日期(1-31) 月(1-12) 周几(0-7,0和7都是周日) * 代表全部

    D. 构建环境

    iOS打包需要签名文件和证书,所以这部分我们勾选“Keychains and Code Signing Identities”。
    这里我们又需要用到Jenkins的插件,在系统管理页面,选择“Keychains and Provisioning Profiles Management”。

    进入Keychains and Provisioning Profiles Management页面,点击“浏览”按钮,分别上传自己的keychain和证书。上传成功后,我们再为keychain指明签名文件的名称。

    • Keychain路径
      /Users/userName/Library/keychains/login.keychain
    • Provisioning Profiles路径
      /Users/userName/Library/MobileDevice/Provisioning Profiles

    点击“Add Code Signing Identity”,最后添加成功后如下图所示:


    这样Adhoc证书和签名文件就在Jenkins中配置好了,接下来我们只需要在item设置中指定相关文件即可。

    回到我们新建的item,找到构建环境,按下图选好自己的相关证书和签名文件。

    E. 构建
    ①增加构建步骤:Execute shell

    作用:改变项目中的build号

    #---------------进入项目工程根目录----------------------------
    cd $HOME/Home/workspace/${JOB_NAME}/xxx(工程名)
    #---------------auto change versionNumber------------------
    #/usr/bin/xcrun agvtool next-marketing-version -all
    #---------------auto change buildNumber--------------------
    /usr/bin/xcrun agvtool new-version -all $BUILD_NUMBER
    
    ②增加构建步骤:Execute shell

    作用:打包,导出IPA
    最好在xcode中设置scheme为shared,否则可能出现工程无scheme的错误

    # 工程名
    APP_NAME="xxx"  #替换成你的工程名
    # 证书
    CODE_SIGN_DISTRIBUTION="iPhone Distribution: xxx Co., Ltd. (xxxxxx)"  # 打包所用签名证书
    # info.plist路径
    project_infoplist_path="$HOME/Home/workspace/${JOB_NAME}/${APP_NAME}/${APP_NAME}/Info.plist"
    #取版本号
    bundleShortVersion=$(/usr/libexec/PlistBuddy -c "print CFBundleShortVersionString" "${project_infoplist_path}")
    #获取日期
    #DATE="$(date +%Y%m%d)"
    ADHOC_PLIST_PATH="xxx/xxx/adhoc.plist"
    #要上传的ipa文件路径
    IPA_PATH="$HOME/Home/output/${JOB_NAME}/${bundleShortVersion}(${BUILD_ID})"
    #创建IPA路径文件夹
    mkdir $IPA_PATH
    #archive文件路径
    ARCHIVE_PATH="${IPA_PATH}/${APP_NAME}_${BUILD_ID}.xcarchive"
    
    #进入工程目录
    cd $HOME/Home/workspace/${JOB_NAME}/${APP_NAME}
    # xcodebuild -list命令可以查看 工程的:Targets、Configurations、Schemes
    
    echo "=================清理工程================="
    xcodebuild clean -target "${APP_NAME}" -configuration 'Release'
    
    echo "=================解锁钥匙串================="
    #解决:codesign"seckey api returned: -25308,(null)"
    # *** 是一般为电脑登录密码
    security unlock-keychain -p "***" "${HOME}/Library/Keychains/login.keychain"
    
    echo "=================生成xcarchive文件================="
    # 在xcode中设置scheme为shared,否则可能出现工程无scheme的错误
    # 还可以添加其他参数,不设置的都是默认使用项目Build Settings里面的配置,包括 CODE_SIGN_IDENTITY 和 PROVISIONING_PROFILE
    xcodebuild archive -project "${APP_NAME}.xcodeproj" -scheme "${APP_NAME}" -sdk iphoneos -configuration "Release" -archivePath "${ARCHIVE_PATH}"
    
    echo "=================打包IPA================="
    xcodebuild -exportArchive -archivePath "${ARCHIVE_PATH}" -exportPath "${IPA_PATH}" -exportOptionsPlist "${ADHOC_PLIST_PATH}"
    

    adhoc.plist 文件内容

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
    <plist version="1.0">
        <dict>
            <key>method</key>
            <string>ad-hoc</string>
            <key>compileBitcode</key>
            <false/>
        </dict>
    </plist>
    
    F、构建后操作

    增加构建后操作步骤:Execute a set of scripts
    建议勾选 Execute script only if build succeeds 只有构建成功,才执行构建后命令
    Build steps => Execute shell

    # 解决中文乱码问题
    export LANG="zh_CN.UTF-8" #zh_CN.UTF-8  en_US.UTF-8
    # 解决 fir: command not found 问题(前提:安装fir命令行工具 - gem install fir(再前提:安装了ruby环境))
    # /usr/local/bin/:  为fir工具安装路径(安装完成fir时会有打印出来)
    export PATH="/usr/local/bin/:$PATH"
    
    APP_NAME="xxx"
    # info.plist路径
    project_infoplist_path="$HOME/Home/workspace/${JOB_NAME}/${APP_NAME}/${APP_NAME}/Info.plist"
    #取版本号
    bundleShortVersion=$(/usr/libexec/PlistBuddy -c "print CFBundleShortVersionString" "${project_infoplist_path}")
    
    cd $HOME/Home/workspace/${JOB_NAME}
    
    log=`git show -s --format=%B $GIT_COMMIT`
    
    cd "$HOME/Home/output/${JOB_NAME}/${bundleShortVersion}(${BUILD_ID})"
    
    fileName=`find . -name "${APP_NAME}.ipa"`
    
    # 上传IPA到fir平台
    fir p "$fileName" -c ${log} -Q -m "./${APP_NAME}_${BUILD_ID}.xcarchive/dSYMs/工程名.app.dSYM/Contents/Resources/DWARF/工程名" -P <bughd project id> -T <fir token>
    
    # 设置上传fir返回二维码图片名称为qrcode.png
    mv "./fir-${$APP_NAME}.png" "./qrcode.png"
    
    # 设置构建版本描述信息为二维码,扫码可下载该构建版本
    # 此设置无效,错误信息如下:
    # [WARN] Failed to authenticate with your SSH keys. Proceeding as anonymous
    # ERROR: No such job 'DESCRIPTION=<p>扫码下载xxx(xx)</p><img src=./qrcode.png>'
    # java -jar ${HOME}/Home/jenkins-cli.jar -s http://localhost:8080/ set-build-description DESCRIPTION="<p>扫码下载${bundleShortVersion}(${BUILD_ID})</p><img src=./qrcode.png>"
    

    解决 fir: command not found 问题

    • 前提:安装fir命令行工具 - gem install fir(再前提:安装了ruby环境)
    • /usr/local/bin/: 为fir工具安装路径(安装完成fir时会有打印出来)
    • export PATH="/usr/local/bin/:$PATH"

    配置set build description 可以使用 HTML标签
    设置如下:

    1. Jenkins -> 系统管理 -> Configure Global Security
    2. Markup Formatter 选择 "Safe HTML"

    解决Unable to access jarfile jenkins-cli.jar 问题

    • 进入 http://localhost:8080/cli/
      Jenkins主网址,8080是默认端口
    • 下载jenkins-cli.jar,并放到Jenkins的一个目录下
      1.右上角“可以下载jenkins-cli.jar”,点击链接即可下载
      2.比如我就放到了$HOME/Home目录中了
      3.修改文件拥有者和用户组为jenkins
    • java -jar jenkins-cli.jar 中 jenkins-cli.jar 文件名 替换为 jenkins-cli.jar 文件的全路径

    注意:小心大坑,在Jenkins HOME目录下新建文件(夹),权限要更改,否则会出现权限问题(Operation denied)

    相关文章

      网友评论

      • 叶小合:您好,我的插件管理,插件一直安装不上
        知德:@叶小合 所有的插件都安不上?提示什么呀
      • 5e470c0b35cb:问一下 Jenkins 执行mac下边的Python脚本 提示找不到目录 这个该怎么解决?
      • zhao1zhihui:Keychains and Provisioning Profiles 插件Provisioning Profiles 路径怎么配置这是我配置的/Users/mac/Library/MobileDevice/Provisioning Profiles 这样子在配置工程Mobile Provisioning Profiles的时候没有选择描述证书的选项求教大佬
      • 星好唯柔:我升级了mac系统high sierra,ruby切换到2.3版本之后,jenkins在打包就显示失败了!!!
      • SHyH5:你好,Unlock Jenkins界面的时候给了一个路径,然后路径下的文件夹说没有权限,请问这个是时候的密码是怎么获取的
        SHyH5:@柯南他姑妈 感谢
        8e746a7af7e6:选中这个密码文件右击-》显示简介-》下拉设置权限 点击右下角解锁图标,输入电脑密码 -》允许everyone“读和写” 再打开此文件就可以看到密码喽
      • 2dfd0ee32d36:请问Mac升级系统后,Jenkins需要重新部署吗?
        知德:@猎鹰jay_wong 那个兄弟,我没看过报告,只用了自动打包上传的功能,所以兄弟对不住了,帮不到你啊
        猎鹰jay_wong:请教个问题,我用的电脑是mac,Jenkins远程直接看报告,不能打开HTML格式,需要怎么设置
        知德:@ldj007 不需要啊,我升级过两次系统,没有重新部署也可以用;但是更新Jenkins插件后,有时候就需要重新配置了

      本文标题:macOS Jenkins安装&配置

      本文链接:https://www.haomeiwen.com/subject/eaeqgttx.html