-
Notifications
You must be signed in to change notification settings - Fork 0
/
Jenkinsfile
677 lines (578 loc) · 28.4 KB
/
Jenkinsfile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
#!groovy
/*
* © 2021. TU Dortmund University,
* Institute of Energy Systems, Energy Efficiency and Energy Economics,
* Research group Distribution grid planning and operation
*/
////////////////////////////////
// general config values
////////////////////////////////
/* project configuration */
String javaVersionId = 'jdk-17' // id that matches the java tool with the java version that should be used set as jenkins property
/* git configuration */
String projectName = 'simonaAPI' // name of the repository, is case insensitive
String orgName = 'ie3-institute' // name of the github organization
String gitCheckoutUrl = "[email protected]:$orgName/${projectName}.git"
String sshCredentialsId = '19f16959-8a0d-4a60-bd1f-5adb4572b702' // id that matches the ssh credentials to interact with the git set as jenkins property
/* ci configuration */
String sonarqubeProjectKey = 'edu.ie3:simonaAPI' // sonarqube project key, case-sensitive
String codeCovTokenId = 'simonaAPI-codecov-token' // id that matches the code coverage token set as jenkins property
/* maven central configuration */
String mavenCentralCredentialsId = '87bfb2d4-7613-4816-9fe1-70dfd7e6dec2' // id that matches the maven central credentials set as jenkins property
String mavenCentralSignKeyFileId = 'dc96216c-d20a-48ff-98c0-1c7ba096d08d' // id that matches the maven central sign key file set as jenkins property
String mavenCentralSignKeyId = 'a1357827-1516-4fa2-ab8e-72cdea07a692' // id that matches the maven central sign key id set as jenkins property
/**
* pipeline configuration
*/
/* setup pipeline properties */
// dev and main need manual deploy capabilities
if (env.BRANCH_NAME == "main" || env.BRANCH_NAME == "dev") {
constantBranchesProps()
} else {
// all other branches need trigger capabilities for PRs
temporaryBranchesProps()
}
/**
* pipeline
*/
node {
ansiColor('xterm') {
try {
// set java version
setJavaVersion(javaVersionId)
// determine branch name that should be checked out
net.sf.json.JSONObject prJsonObj = getPRJsonObj(orgName, projectName, env.CHANGE_ID)
String currentBranchName = prJsonObj == null ? env.BRANCH_NAME : prJsonObj.head.ref
String targetBranchName = prJsonObj == null ? null : prJsonObj.base.ref
/* prs from forks require a special handling*/
String headGitCheckoutUrl = prJsonObj == null ? gitCheckoutUrl : prJsonObj.head.repo.ssh_url
// checkout scm
String commitHash = ""
stage('checkout') {
// commit hash from scm checkout
// https://www.theserverside.com/blog/Coffee-Talk-Java-News-Stories-and-Opinions/Complete-Jenkins-Git-environment-variables-list-for-batch-jobs-and-shell-script-builds
commitHash = gitCheckout(projectName, headGitCheckoutUrl, currentBranchName, sshCredentialsId).GIT_COMMIT
}
// set build display name
String displayNameBranchName = prFromFork() ? prJsonObj.head.repo.full_name : currentBranchName
currentBuild.displayName = determineDisplayName(displayNameBranchName, commitHash, orgName, projectName)
if (currentBranchName == "main") {
stage('handle dev pr') {
// normally main pipeline is only triggered by merge of release or hotfixes OR manually triggered
// if manually triggered for deploy, no PR should be created
if (params.deploy != "true") {
// Disabled for now
// handleDevPr(sshCredentialsId, orgName, projectName, currentBranchName)
}
}
}
// version check
stage('version check') {
// version check can only be executed, if target branch is known (derived from a PR)
if (targetBranchName == "main" || targetBranchName == "dev") {
if (checkVersion(currentBranchName, targetBranchName, projectName, projectName, gitCheckoutUrl, headGitCheckoutUrl, sshCredentialsId) != 0)
error "Version check failed! See log for version differences."
} else if (targetBranchName == null) {
// if this branch is the dev branch, we can still do version check to compare if dev and main have the same semnatic version
if (env.BRANCH_NAME == "dev") {
if (checkVersion(currentBranchName, "main", projectName, projectName, gitCheckoutUrl, headGitCheckoutUrl, sshCredentialsId) != 0)
error "Version check failed! See log for version differences."
} else {
println "No PR for branch '$currentBranchName' exists. Cannot check versioning! Please create a PR to enable version check."
}
} else {
error "Target branch name '$targetBranchName' for merging is not supported! Please select either 'dev' or 'main' as " +
"target branch for merging!"
}
}
// test the project
stage('run tests') {
sh 'java -version'
gradle('--refresh-dependencies clean spotlessCheck pmdMain pmdTest ' +
'test jacocoTestReport jacocoTestCoverageVerification', projectName)
sh(script: """set +x && cd $projectName""" + ''' set +x; ./gradlew javadoc''', returnStdout: true)
}
// sonarqube analysis
stage('sonarqube analysis') {
String sonarqubeCurrentBranchName = prFromFork() ? prJsonObj.head.repo.full_name : currentBranchName // forks needs to be handled differently
String sonarqubeCmd = determineSonarqubeGradleCmd(sonarqubeProjectKey, sonarqubeCurrentBranchName, targetBranchName, orgName, projectName, projectName)
withSonarQubeEnv() {
// will pick the global server connection from jenkins for sonarqube
gradle(sonarqubeCmd, projectName)
}
}
// sonarqube quality gate
stage("quality gate") {
timeout(time: 1, unit: 'HOURS') {
// just in case something goes wrong, pipeline will be killed after a timeout
def qg = waitForQualityGate() // reuse taskId previously collected by withSonarQubeEnv
if (qg.status != 'OK') {
error "Pipeline aborted due to quality gate failure: ${qg.status}"
}
}
}
// deploy stage only if branch is main or dev
if (env.BRANCH_NAME == "main" || env.BRANCH_NAME == "dev") {
stage('deploy') {
// determine project version
String projectVersion = sh(returnStdout: true, script: "set +x && cd ${projectName}; ./gradlew -q " +
"${(env.BRANCH_NAME == "dev") ? "devVersion" : "currentVersion"}").toString().trim()
// get the sonatype credentials stored in the jenkins secure keychain
withCredentials([
usernamePassword(credentialsId: mavenCentralCredentialsId, usernameVariable: 'MAVENCENTRAL_USER', passwordVariable: 'MAVENCENTRAL_PASS'),
file(credentialsId: mavenCentralSignKeyFileId, variable: 'MAVENCENTRAL_KEYFILE'),
usernamePassword(credentialsId: mavenCentralSignKeyId, usernameVariable: 'MAVENCENTRAL_SIGNINGKEYID', passwordVariable: 'MAVENCENTRAL_SIGNINGPASS')
]) {
/*
* IMPORTANT: Do not issue 'clean' in the following task
*/
sh(
script: """set +x && cd $projectName""" +
''' set +x; ./gradlew clean javadoc''',
returnStdout: true
)
String deployGradleTasks = '--refresh-dependencies test ' +
'publish -Puser=${MAVENCENTRAL_USER} ' +
'-Ppassword=${MAVENCENTRAL_PASS} ' +
'-Psigning.keyId=${MAVENCENTRAL_SIGNINGKEYID} ' +
'-Psigning.password=${MAVENCENTRAL_SIGNINGPASS} ' +
'-Psigning.secretKeyRingFile=${MAVENCENTRAL_KEYFILE} ' +
"-PdeployVersion='$projectVersion'"
gradle(deployGradleTasks, projectName)
}
if (env.BRANCH_NAME == "main") {
// create tag on main and push it to origin
createAndPushTagOnMain(projectName, sshCredentialsId)
// todo JH create github release
// deploy java docs
deployJavaDocs(projectName, sshCredentialsId, gitCheckoutUrl)
}
}
}
// post processing
stage('post processing') {
// publish reports
publishReports(projectName)
// call codecov.io
withCredentials([
string(credentialsId: codeCovTokenId, variable: 'codeCovToken')
]) {
sh "curl -s https://codecov.io/bash | bash -s - -t ${env.codeCovToken} -C ${commitHash}"
}
}
} catch (Exception e) {
// set build result to failure
currentBuild.result = 'FAILURE'
// publish reports even on failure
publishReports(projectName)
// print exception
Date date = new Date()
println("[ERROR] [${date.format("dd/MM/yyyy")} - ${date.format("HH:mm:ss")}] " + e)
}
}
}
/**
* pipeline stages - all methods require node context
*/
def setJavaVersion(String javaVersionId) {
env.JAVA_HOME = "${tool javaVersionId}"
env.PATH = "${env.JAVA_HOME}/bin:${env.PATH}"
}
/* git interaction */
def gitCheckout(String relativeTargetDir, String gitCheckoutUrl, String branch, String sshCredentialsId) {
checkout([
$class : 'GitSCM',
branches : [[name: branch]],
doGenerateSubmoduleConfigurations: false,
extensions : [
[$class: 'RelativeTargetDirectory', relativeTargetDir: relativeTargetDir]
],
submoduleCfg : [],
userRemoteConfigs : [
[credentialsId: sshCredentialsId, url: gitCheckoutUrl]
]
])
}
def handleDevPr(String sshCredentialsId, String orgName, String projectName, String currentBranchName) {
// get the latest merge string from git to derive latest commit hash + latest merge branch name
String gitLogLatestMergeString = ""
withCredentials([
sshUserPrivateKey(credentialsId: sshCredentialsId, keyFileVariable: 'sshKey')
]) {
// cleanup to prepare repo
sh(script:
"set +x && cd $projectName && " +
"ssh-agent bash -c \"set +x && ssh-add $sshKey; " +
"git branch | grep -v \"$currentBranchName\" | xargs git branch -D;" + // deletes all local branches except main
"git fetch && git checkout $currentBranchName && git pull\"", returnStdout: false)
gitLogLatestMergeString = sh(script: "cd $projectName && set +x && git log --merges -n 1", returnStdout: true)
}
// only create pr if the last merge has been a hotfix or a release branch merge
boolean isHotfix = gitLogLatestMergeString.find("Merge pull request .+ from .*hotfix/\\pL{2}/#\\d+.*") ? true : false
boolean isRelease = gitLogLatestMergeString.find("Merge pull request .+ from .*rel/\\pL{2}/#\\d+.*") ? true : false
if (isHotfix || isRelease) {
// try to get hotfix first, if this fails try to get release
String latestMergeBranchName = ""
if (isHotfix) {
String hotfixRegex = "hotfix/\\pL{2}/#\\d+.*"
latestMergeBranchName = (gitLogLatestMergeString.find(hotfixRegex).trim() =~ hotfixRegex)[0]
} else {
String relRegex = "rel/\\pL{2}/#\\d+.*"
latestMergeBranchName = (gitLogLatestMergeString.find(relRegex).trim() =~ relRegex)[0]
}
// get the latest merge commit sha
String latestMergeCommitSHA = gitLogLatestMergeString.find("Merge: .* .*\n").trim().split(" ")[2]
// create new branch with same name as before + hand in a pull request for dev branch,
// if the branch already exists catch the exception because then we can just go on for a PR
try {
withCredentials([
sshUserPrivateKey(credentialsId: sshCredentialsId, keyFileVariable: 'sshKey')
]) {
sh(script: "set +x && cd $projectName && " +
"ssh-agent bash -c \"set +x && ssh-add $sshKey; " +
"git fetch && git checkout $currentBranchName && git pull && " +
"git checkout -b $latestMergeBranchName $latestMergeCommitSHA && " +
"git push --set-upstream origin $latestMergeBranchName\"")
}
} catch (Exception e) {
println "No need to create a new branch. Can reuse old one."
}
// create PR on dev branch
withCredentials([
string(credentialsId: 'SimServCIDeveloperAccessTokenForWebhooks', variable: 'SimServCIToken')
]) {
String issueId = (latestMergeBranchName =~ ".*(#\\d+).*")[0][1]
String prMessage = "CI generated PR for branch `$latestMergeBranchName` after merging it into `main`.\\n" +
"Please review, adapt and merge it into `dev`.\\nResolves $issueId."
String curlCmd = "set +x && " +
"curl -s -X POST -u johanneshiry:$SimServCIToken -H \"Accept: application/vnd.github.v3+json\"" +
" https://api.github.com/repos/$orgName/$projectName/pulls" +
" -d '{ \"title\": \"$latestMergeBranchName for dev\", \"body\": \"$prMessage\", \"head\": \"$latestMergeBranchName\", \"base\": \"dev\"," +
"\"draft\":\"true\"}'"
sh(script: curlCmd, returnStdout: true)
}
// switch back to main branch for further processing
sh(script: "set +x && cd $projectName && git checkout $currentBranchName")
}
}
def createAndPushTagOnMain(String projectName, String sshCredentialsId) {
String tagBranchName = 'main'
String projectVersion =
sh(returnStdout: true, script: "set +x && cd ${projectName}; ./gradlew -q printVersion").trim()
try {
withCredentials([
sshUserPrivateKey(credentialsId: sshCredentialsId, keyFileVariable: 'sshKey')
]) {
// set tagging mail and name in git config
sh(script: "set +x && cd $projectName && " +
"git config user.email '[email protected]' && " +
"git config user.name 'Johannes Hiry'", returnStdout: false)
// cleanup repo and tag it afterwards
sh(script:
"set +x && cd $projectName && " +
"ssh-agent bash -c \"set +x && ssh-add $sshKey; " +
"git branch | grep -v \"$tagBranchName\" | xargs git branch -D; " + // deletes all local branches except tagBranchName
"git fetch && git checkout $tagBranchName && git pull && " +
"git tag -m 'Release version $projectVersion.' $projectVersion && " +
"git push origin --tags" +
"\"", returnStdout: false)
}
} catch (Exception e) {
println "Error when creating tag on main branch! Exception: $e"
}
}
def deployJavaDocs(String projectName, String sshCredentialsId, String gitCheckoutUrl) {
try {
withCredentials([
sshUserPrivateKey(credentialsId: sshCredentialsId, keyFileVariable: 'sshKey')
]) {
// set mail and name in git config
sh(script: "set +x && cd $projectName && " +
"git config user.email '[email protected]' && " +
"git config user.name 'Johannes Hiry'", returnStdout: false)
// create a temporary repo in the javadocs folder and push the updated javadocs to api-docs branch
sh(script: "set +x && cd $projectName && " +
"./gradlew clean && rm -rf tmp-api-docs && mkdir tmp-api-docs && cd tmp-api-docs && " +
"ssh-agent bash -c \"set +x && ssh-add $sshKey; " +
"git init && git remote add origin $gitCheckoutUrl && " +
"git config user.email '[email protected]' && " +
"git config user.name 'Johannes Hiry' && " +
"git fetch --depth=1 origin api-docs && " +
"git checkout api-docs && " +
"cd .. && ./gradlew clean javadoc && " +
"cp -R build/docs/javadoc/* tmp-api-docs && " +
"cd tmp-api-docs &&" +
"git add --all && git commit -m 'updated api-docs' && git push origin api-docs:api-docs" +
"\"",
returnStdout: false)
}
} catch (Exception e) {
println "Error when deploying javadocs! Exception: $e"
}
}
/* gradle */
def gradle(String command, String relativeProjectDir) {
env.JENKINS_NODE_COOKIE = 'dontKillMe' // this is necessary for the Gradle daemon to be kept alive
// switch directory to be able to use gradle wrapper
sh(script: """set +x && cd $relativeProjectDir""" + ''' set +x; ./gradlew ''' + command, returnStdout: true)
}
def determineSonarqubeGradleCmd(String sonarqubeProjectKey, String currentBranchName, String targetBranchName, String orgName, String projectName, String relativeGitDir) {
String prBaseBranch = targetBranchName == null ? "dev" : targetBranchName
switch (currentBranchName) {
case "main":
return "sonarqube -Dsonar.branch.name=main -Dsonar.projectKey=$sonarqubeProjectKey"
break
case "dev":
String[] branchVersion = gradle("-q currentVersion", relativeGitDir).toString().split('\\.')
Integer major = branchVersion[0].toInteger()
Integer minor = branchVersion[1].toInteger()
String projectVersion = "${major}.${minor}-SNAPSHOT"
return "sonarqube -Dsonar.projectVersion=${projectVersion} -Dsonar.projectKey=$sonarqubeProjectKey"
break
default:
String gradleCommand = "sonarqube -Dsonar.projectKey=$sonarqubeProjectKey"
// if this branch has a PR, the sonarqube cmd needs to be adapted
if (env.CHANGE_ID == null) {
// no PR exists
return gradleCommand + " -Dsonar.branch.name=${currentBranchName}"
} else {
// PR exists, adapt cmd accordingly
return gradleCommand + " -Dsonar.pullrequest.branch=${currentBranchName} -Dsonar.pullrequest.key=${env.CHANGE_ID} " +
"-Dsonar.pullrequest.base=$prBaseBranch -Dsonar.pullrequest.github.repository=${orgName}/${projectName} " +
"-Dsonar.pullrequest.provider=Github"
}
break
}
}
def determineDisplayName(String currentBranchName, String commitHash, String orgName, String projectName) {
String displayName = ""
if (currentBranchName == "main" || currentBranchName == "dev") {
// main and dev are always merge branches
def jsonObject = getGithubCommitJsonObj(commitHash, orgName, projectName)
displayName = "${jsonObject.commit.message} (${currentBuild.displayName})"
} else {
displayName = currentBranchName + " (" + currentBuild.displayName + ")"
}
return displayName
}
def publishReports(String relativeProjectDir) {
// publish test reports
publishHTML([allowMissing: true, alwaysLinkToLastBuild: true, escapeUnderscores: false, keepAll: true, reportDir: relativeProjectDir + '/build/reports/tests/test', reportFiles: 'index.html', reportName: "${relativeProjectDir}_java_tests_report", reportTitles: ''])
// publish jacoco report for main project only
publishHTML([allowMissing: true, alwaysLinkToLastBuild: true, escapeUnderscores: false, keepAll: true, reportDir: relativeProjectDir + '/build/reports/jacoco', reportFiles: 'index.html', reportName: "${relativeProjectDir}_jacoco_report", reportTitles: ''])
// publish pmd report for main project only
publishHTML([allowMissing: true, alwaysLinkToLastBuild: true, escapeUnderscores: false, keepAll: true, reportDir: relativeProjectDir + '/build/reports/pmd', reportFiles: 'main.html', reportName: "${relativeProjectDir}_pmd_report", reportTitles: ''])
}
def prFromFork() {
return env.CHANGE_FORK != null
}
/**
* utility functions - methods that does not require node context
*/
/* properties */
def constantBranchesProps() {
properties([
parameters(
[
string(defaultValue: '', description: '', name: 'deploy', trim: true)
]),
[$class: 'ThrottleJobProperty', categories: [], limitOneJobWithMatchingParams: false, maxConcurrentPerNode: 0, maxConcurrentTotal: 0, paramsToUseForLimit: '', throttleEnabled: true, throttleOption: 'project']
])
}
def temporaryBranchesProps() {
properties(
[
pipelineTriggers([
issueCommentTrigger('.*!test.*')
])
])
}
/* git interaction */
def getGithubCommitJsonObj(String commit_sha, String orgName, String repoName) {
def jsonObj = readJSON text: curlByCSHA(commit_sha, orgName, repoName)
return jsonObj
}
def curlByCSHA(String commit_sha, String orgName, String repoName) {
def curlUrl = "curl -s https://api.github.com/repos/" + orgName + "/" + repoName + "/commits/" + commit_sha
String jsonResponseString = sh(script: curlUrl, returnStdout: true)
return jsonResponseString
}
def getGithubPRJsonObj(String prId, String orgName, String repoName) {
def jsonObj = readJSON text: curlByPR(prId, orgName, repoName)
return jsonObj
}
def curlByPR(String prId, String orgName, String repoName) {
def curlUrl = "set +x && curl -s https://api.github.com/repos/" + orgName + "/" + repoName + "/pulls/" + prId
String jsonResponseString = sh(script: curlUrl, returnStdout: true)
return jsonResponseString
}
def getPRJsonObj(String orgName, String projectName, String changeId) {
if (changeId == null) {
return null
} else {
// PR exists, curl the api and retrieve target branch
return getGithubPRJsonObj(changeId, orgName, projectName)
}
}
def checkVersion(String branchName, String targetBranchName, String relativeGitDir,
String projectName,
String baseGitCheckoutUrl,
String headGitCheckoutUrl,
String sshCredentialsId) {
// get current branch type
// if headGitCheckoutUrl is set (= pr from fork), this branch type is always treated as a feature branch
String branchType = prFromFork() ? "feature" : getBranchType(branchName)
if (branchType == null) {
println "Cannot derive branch type from current branch with name '$branchName'."
return -1
}
// compare the version
/// save the current version string
String[] currentVersion = gradle("-q currentVersion", relativeGitDir).toString().split('\\.')
/// switch to the comparison branch, this is always the base git checkout url
gitCheckout(projectName, baseGitCheckoutUrl, targetBranchName, sshCredentialsId)
String[] targetBranchVersion = gradle("-q currentVersion", relativeGitDir).toString().split('\\.')
if (compareVersionParts(branchType, currentVersion, getBranchType(targetBranchName), targetBranchVersion) != 0) {
// comparison failed
return -1
} else {
// switch back to current branch. Select url depending on if this is a fork or not
gitCheckout(projectName, headGitCheckoutUrl, branchName, sshCredentialsId)
return 0
}
}
def compareVersionParts(String sourceBranchType, String[] sourceBranchVersion, String targetBranchType, String[] targetBranchVersion) {
switch (sourceBranchType) {
case "hotfix":
if (targetBranchType == "main") {
boolean major = sourceBranchVersion[0].toInteger() == targetBranchVersion[0].toInteger()
boolean minor = sourceBranchVersion[1].toInteger() == targetBranchVersion[1].toInteger()
boolean patch = (sourceBranchVersion[2].toInteger() == targetBranchVersion[2].toInteger() + 1)
if (major && minor && patch) {
return 0
} else {
println "Hotfix branch versioning is invalid in comparison to main branch versioning. " +
"Only mainBranch.patchVersion + 1 is allowed for hotfix branch!\n" +
"hotfixVersion: ${sourceBranchVersion[0]}.${sourceBranchVersion[1]}.${sourceBranchVersion[2]}\n" +
"mainVersion: ${targetBranchVersion[0]}.${targetBranchVersion[1]}.${targetBranchVersion[2]}"
return -1
}
} else if (targetBranchType == "dev") {
boolean major = sourceBranchVersion[0].toInteger() == targetBranchVersion[0].toInteger()
boolean minor = sourceBranchVersion[1].toInteger() == targetBranchVersion[1].toInteger()
boolean patch = (sourceBranchVersion[2].toInteger() == 0 && targetBranchVersion[2].toInteger() == 0)
if (major && minor && patch) {
return 0
} else {
println "Hotfix branch versioning is invalid in comparison to dev branch versioning. " +
"Major and minor version must be equal and patch version must be 0.\n" +
"hotfixVersion: ${sourceBranchVersion[0]}.${sourceBranchVersion[1]}.${sourceBranchVersion[2]}\n" +
"devVersion: ${targetBranchVersion[0]}.${targetBranchVersion[1]}.${targetBranchVersion[2]}"
return -1
}
} else {
// invalid branch type for hotfix merge
return -1
}
break
case "feature":
if (targetBranchType == "dev") {
// no change in semVer allowed
boolean major = sourceBranchVersion[0].toInteger() == targetBranchVersion[0].toInteger()
boolean minor = sourceBranchVersion[1].toInteger() == targetBranchVersion[1].toInteger()
boolean patch = (sourceBranchVersion[2].toInteger() == 0 && targetBranchVersion[2].toInteger() == 0)
if (major && minor && patch) {
return 0
} else {
println "Feature branch versioning differs from dev branch versioning. This is not allowed!\n" +
"featureVersion: ${sourceBranchVersion[0]}.${sourceBranchVersion[1]}.${sourceBranchVersion[2]}\n" +
"devVersion: ${targetBranchVersion[0]}.${targetBranchVersion[1]}.${targetBranchVersion[2]}"
return -1
}
} else {
// invalid branch type for feature merge
println "Invalid target branch type '$targetBranchType' for feature branch. Feature branches can only" +
"be merged into dev branch!"
return -1
}
break
case "release":
if (targetBranchType == "main" || targetBranchType == "dev") {
Integer targetMajor = targetBranchVersion[0].toInteger()
Integer targetMinor = targetBranchVersion[1].toInteger()
Integer sourceMajor = sourceBranchVersion[0].toInteger()
Integer sourceMinor = sourceBranchVersion[1].toInteger()
boolean validCheck1 = targetMajor == sourceMajor && targetMinor + 1 == sourceMinor
boolean validCheck2 = targetMajor + 1 == sourceMajor
// patch version always needs to be 0
boolean patchValid = sourceBranchVersion[2].toInteger() == 0
if ((validCheck1 || validCheck2) && patchValid) {
return 0
} else {
println "Release branch versioning does not fit to main branch versioning!\nA release should increase " +
"either major or minor version and reset patch version to 0.\n" +
"releaseVersion: ${sourceBranchVersion[0]}.${sourceBranchVersion[1]}.${sourceBranchVersion[2]}\n" +
"${targetBranchType == "main" ? "mainVersion" : "devVersion"}: ${targetBranchVersion[0]}.${targetBranchVersion[1]}.${targetBranchVersion[2]}"
return -1
}
} else {
// invalid target branch type for release merge
println "Merging release branch into branch type '$targetBranchType' is not supported! Realease branches" +
"can only be merged into main or dev branch!"
return -1
}
// major == major OR major == major + 1, minor == minor OR minor == minor + 1, patch == patch == 0
break
case "dev":
// target branch type can only be main branch
if (targetBranchType == "main") {
// only major and minor version parts need to be checked
Integer targetMajor = targetBranchVersion[0].toInteger()
Integer targetMinor = targetBranchVersion[1].toInteger()
Integer sourceMajor = sourceBranchVersion[0].toInteger()
Integer sourceMinor = sourceBranchVersion[1].toInteger()
boolean validCheck1 = targetMajor == sourceMajor && targetMinor + 1 == sourceMinor
boolean validCheck2 = targetMajor + 1 == sourceMajor
// patch version always needs to be 0
boolean patchValid = sourceBranchVersion[2].toInteger() == 0
if ((validCheck1 || validCheck2) && patchValid) {
return 0
} else {
println "Dev branch versioning does not fit to main branch versioning! Must increase either major or minor version!\n" +
"devVersion: ${sourceBranchVersion[0]}.${sourceBranchVersion[1]}.${sourceBranchVersion[2]}\n" +
"mainVersion: ${targetBranchVersion[0]}.${targetBranchVersion[1]}.${targetBranchVersion[2]}"
return -1
}
} else {
// invalid branch type for dev branch version comparison
println "Invalid branch type '$targetBranchType' to be compared with dev branch. Dev branch version " +
"can only be compared with main branch type!"
return -1
}
break
default:
return -1
break
}
}
def getBranchType(String branchName) {
def dev_pattern = "^(developer|develop|dev)\$"
def release_pattern = ".*rel/.*"
def feature_pattern = "^\\pL{2}/#\\d+.*"
def dependabot_pattern = "^dependabot/.*\$"
def hotfix_pattern = ".*hotfix/\\pL{2}/#\\d+.*"
def main_pattern = ".*main"
if (branchName =~ feature_pattern || branchName =~ dependabot_pattern) {
return "feature"
} else if (branchName =~ release_pattern) {
return "release"
} else if (branchName =~ main_pattern) {
return "main"
} else if (branchName.toLowerCase() =~ dev_pattern) {
return "dev"
} else if (branchName =~ hotfix_pattern) {
return "hotfix"
} else {
return null
}
}