05 GitHub Repo通过Jenkinsfile接入到Jenkins

目前完成02-04的jenkins及其配置后,我们现在可以通过Jenkinsfile来接入到我们的Jenkins中了,此文档简单介绍如何接入Jenkins。

先决条件

  • 完成02-04的Jenkins及其配置

  • 顺利的跑完所有node的可用性测试


    node可用性测试
  • 确保你的Github Repo的根目录有Jenkinsfile,并且你的agent { label "node-team-n" }的label为开发团队指定的label,并了解Jenkinsfile的编写,更多Jenkinsfile参考以下链接:
    Jenkinsfile参考Jenkinsfile
    Pipeline语法参考:syntax
    Docker handling in Jenkinsfile: https://jenkins.io/doc/book/pipeline/docker/

  • 当前此测试已有的有label如下:

TEAM LABEL NAMESPACE NOTE
test team1 node-team1 node-team1 apk add --upgrade docker sudo shadow git python py-pip curl libcurl nss
test team2 node-team2 node-team2 apk add --upgrade docker sudo shadow git python py-pip curl libcurl nss maven
test team3 node-team3 node-team3 apk add --upgrade docker sudo shadow git python py-pip curl libcurl nss
test team4 node-team4 node-team4 apk add --upgrade docker sudo shadow git python py-pip curl libcurl nss perl

引用label的语法如下:

pipeline {
 
    agent { label "<your-team-label>" } // Change to your own team's node, like "node-team1", "node-team2"
 
    stages {
        stage('Test Stage') {
            steps {
                sh 'printenv'
                sh 'pwd'
            }
        }
.....

【SRE】创建不同team的Github Organization文件夹

以node-team1为例


node-team1-github-org-folder.gif

最终我们是有不同的folder,然后每个开发组都应该在自己的folder内配置或者接入自己组内的GitHub Repos


image.png

【开发者】新Repo接入到Jenkins中

Jenkins 地址: 请从03 Jenkins master安装(在Kubernetes平台上)获取
node-team1为例,我们向其中添加新repo,名为jenkins-test

  1. 请按照“先决条件”章节来编写新Repo的Jenkinsfile文件,并且确保此文件是放在Repo的根目录下
  2. 打开jenkinsUrl,并进入到对应team的目录,以下以node-team1为例。
  3. 进入node-team1那个目录,然后点击配置
    image.png
  4. 把repo的名字依次写入到Filter by name的输入框
    jenkins-test|jenkins-test2|jenkins-tes3
image.png
  1. 点击保存项目即可,稍后我们会发现在node-team1的目录下会多出jenkins-test的新项目
    image.png

当一个repo接入到Jenkins中,发生了什么

  1. GitHub organization会自动的扫描组织(当前测试的是george-sre)下的所有repo,扫描所有Filter by name (with regular expression)的配置部分的repo,如果任何的branch或者PR中有Jenkinsfile,那么会为其配置相应的任务并自动触发,其他为出现在配置中的repo都自动ignore

  2. Jenkins会通过webhook插件https://github.com/george-sre/jenkins-master/blob/master/script/init.groovy.override#L29配置repo的webhook,为后续自动trigger配置好webhook功能

可以通过查看repo的settings->Webhooks查看


image.png
  1. 后续的repo发生任何的变化都会通过webhook传送到jenkins中并触发相应的动作,包括及不限以下几种:
  • git push触发build
  • 新branch会自动创建branch类型的job
  • 新PR会自动创建PR类型的job
  • [optional]配置git tag触发的job
  • [optional]配置按照名字正则表达式来决定是否处罚的job

查看Jenkins Job的结果

  1. 可以在Jenkins主页找到具体项目的job查看
  2. 可以通过如下位置的github commit status状态链接查看
    commit status
  3. 详细结果界面(Ocean blue)


    Ocean Blue

关于Jenkins Pipeline和GitHub交互的几点说明

  • 目前我们尽量保持Jenkins和GitHub交互的模式和CircleCI一致
    默认GitHub organization配置
    Discover branches: Exclude branches that are filed as PRs (当前分支test-branch-1, test-branch-2如果已经开了PR, PR-20, PR-21,那么当前分支的job test-branch-1, test-branch-2会被disable掉)


    branch job disabled when PR created

如果删除“Discover branches”配置,那么默认不会有“Pull Requests”分类的Job出现。

  • 第一次PR的时候有可能出现两个Build Checks, branch那个直接引用之前的job build result,continuous-integration/jenkins/pr-merge 会起一个新的Job build。如果我们有后续的提交到这个PR,后面branch类型的job会被disable掉,所有的build都只会在continuous-integration/jenkins/pr-merge中build,不会出现重复build。
pr-merge or branch build
  • 极端情况:如果我们的PR开了以后并没有后续的commit,那么我们PR中确实会有两个build check。并且branch的build因为种种原因没有通过build,只有continuous-integration/jenkins/pr-merge通过build check
    我们应该保证continuous-integration/jenkins/pr-merge是OK的,而且可以在GitHub设置中设置merge条件


    merge条件

问题

  • 如果新接入的repo没有出现在node-team的文件夹中,可以通过查看Scan Organization Log来看一下是扫描的结果

参考

https://jenkins.io/doc/book/pipeline/syntax/

https://github.com/george-sre/jenkins-test

更多

云平台开发运维解决方案@george.sre

个人主页:https://geekgoogle.com

GitHub: https://github.com/george-sre

Mail: george.sre@hotmail.com

简书: georgesre - 简书

欢迎交流~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345