ES-1313: changes for better future forward merges (#7486)

* add more comments as a form of documentation
* move variable names away from calling pipeline for better experience
of future forward merges if pipeline parameters were to change
This commit is contained in:
Waldemar Żurowski 2023-09-07 13:39:02 +01:00 committed by GitHub
parent 8e2115293a
commit dfe0ed294e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,8 +1,31 @@
@Library('corda-shared-build-pipeline-steps@5.1') _
forwardMerger(
targetBranch: 'release/os/4.7',
originBranch: 'release/os/4.6',
slackChannel: '#c4-forward-merge-bot-notifications'
)
/*
* Forward merge any changes in current branch to the branch with following version.
*
* Please note, the branches names are intentionally separated as variables, to minimised conflicts
* during automated merges for this file.
*
* These variables should be updated when a new version is cut
*/
/**
* the branch name of origin branch, it should match the current branch
* and it acts as a fail-safe inside {@code forwardMerger} pipeline
*/
String originBranch = 'release/os/4.6'
/**
* the branch name of target branch, it should be the branch with the next version
* after the one in current branch.
*/
String targetBranch = 'release/os/4.7'
/**
* Forward merge any changes between #originBranch and #targetBranch
*/
forwardMerger(
targetBranch: targetBranch,
originBranch: originBranch,
slackChannel: '#c4-forward-merge-bot-notifications',
)