• 对于注定会优秀的人来说,他所需要的,只是时间!
  • 手懒得,必受贫穷,手勤的,必得富足----《圣经》
  • 帮助别人,成就自己。愿君在本站能真正有所收获!
  • 如果你在本站中发现任何问题,欢迎留言指正!
  • 宝剑锋从磨砺出,梅花香自苦寒来!

<四十二>Jenkins实战应用–git-Parameter插件在pipeline共享库中的实践详解

Jenkins eryajf 4个月前 (12-26) 693°C 已收录 0个评论
本文预计阅读时间 5 分钟
文章目录[隐藏]

此插件能够方便的动态获取远程仓库的分支以及tag,从而便于开发者通过搜索快速构建自己想要部署的分支。

这里仅以如下内容作为参考,用最详细的参数,一次讲解分支与tag同时可用的方案如下:

pipeline {
    agent any
    environment {
        // 定义项目git地址
        GIT_URL="https://github.com/klimas7/exampleA.git"
    }
    parameters {
        gitParameter (branch:'', branchFilter: 'origin/(.*)', defaultValue: 'master', description: '选择将要构建的分支', name: 'BRANCH', quickFilterEnabled: true, selectedValue: 'TOP', sortMode: 'DESCENDING_SMART', tagFilter: '*', type: 'PT_BRANCH_TAG', useRepository: env.GIT_URL)
    }
    stages {
        stage('Example') {
            steps {
                checkout(
                    [$class: 'GitSCM', doGenerateSubmoduleConfigurations: false, submoduleCfg: [], extensions: [[$class: 'CloneOption', depth: 1, noTags: false, reference: '', shallow: true]],
                    branches: [[name: "$BRANCH"]],userRemoteConfigs: [[url: "${env.GIT_URL}", credentialsId: "cicd-pass"]]]
                )
            }
        }
    }
}

如上参数基本上已经涵盖了所有的可用选项,接下来对各个参数进行一一详细解读。

重要参数

  • name:定义最终选择之后赋值的变量名称,注意与checkout中要对应上。
  • type:指定过滤的类型,除去另外两个不常用的,基本上直接选择第三个就好。
    可选参数有如下几项:

    • PT_TAG:标签
    • PT_BRANCH:分支
    • PT_BRANCH_TAG:分支或标签
    • PT_REVISION:修订版本,不常用
    • PT_PULL_REQUEST:pull请求,不常用
  • branchFilter:一般这里必须设置为 'origin/(.*)’,否则将无法正常获取分支或标签。
  • defaultValue:在共享库场景中,包含多个仓库,需要构建两次配置才能落位,所以这里最好全部写成master。
  • quickFilterEnabled:是否开启搜索功能,非常好用,当然设为true。
  • useRepository:非常关键,如果一个流水线中有多个git仓库的定义,则指定git仓库才能让插件正常发挥作用。

辅助参数

  • description:定义该参数的说明信息。
  • branch:定义要查找的分支名称,不过此参数一般不设置任何内容。
  • selectedValue:定义选择的排序方式,可选参数有如下几项:NONETOPDEFAULT,一般用TOP就好。
  • sortMode:定义数据的排序方式,有:NONEASCENDING_SMARTDESCENDING_SMARTASCENDINGDESCENDING,一般使用 DESCENDING_SMART倒序即可。
  • tagFilter:标签的过滤,一般不需要过滤,直接用 *

以上基本上就是该插件的所有参数的详解了,一般情况下,知道了pipeline中的配置方式,那么只需要一跑,在自由风格中配置也都是易如反掌的事情了。

我在共享库当中应用的时候,发现首次构建之后,总是无法正常使用该插件,那么基于默认项,点两次构建之后,插件就能够正常使用了,当然,这里需要排除掉Jenkins主机无法正常拉取对应代码的情况。


weinxin
扫码订阅本站,第一时间获得更新
微信扫描二维码,订阅我们网站的动态,另外不定时发送WordPress小技巧,你可以随时退订,欢迎订阅哦~

二丫讲梵 , 版权所有丨如未注明 , 均为原创丨本网站采用BY-NC-SA协议进行授权 , 转载请注明<四十二>Jenkins实战应用–git-Parameter插件在pipeline共享库中的实践详解
喜欢 (2)
[如果想支持本站,可支付宝赞助]
分享 (0)
eryajf
关于作者:
学无止境,我愿意无止境学。书山有路,我愿意举身投火,淬炼成金!永远不要忘记,激情的奋进,就是美好的未来!

您必须 登录 才能发表评论!