mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
Add PR comments to pipeline (#51504)
This commit is contained in:
Brian Seeders
GitHub
parent
d1de029b88
commit
5d5a4ca0ab
2 changed files with 212 additions and 37 deletions
76
Jenkinsfile
vendored
76
Jenkinsfile
vendored
|
|
@ -7,43 +7,45 @@ stage("Kibana Pipeline") { // This stage is just here to help the BlueOcean UI a
|
|||
timeout(time: 120, unit: 'MINUTES') {
|
||||
timestamps {
|
||||
ansiColor('xterm') {
|
||||
catchError {
|
||||
parallel([
|
||||
'kibana-intake-agent': kibanaPipeline.legacyJobRunner('kibana-intake'),
|
||||
'x-pack-intake-agent': kibanaPipeline.legacyJobRunner('x-pack-intake'),
|
||||
'kibana-oss-agent': kibanaPipeline.withWorkers('kibana-oss-tests', { kibanaPipeline.buildOss() }, [
|
||||
'oss-firefoxSmoke': kibanaPipeline.getPostBuildWorker('firefoxSmoke', { runbld('./test/scripts/jenkins_firefox_smoke.sh', 'Execute kibana-firefoxSmoke') }),
|
||||
'oss-ciGroup1': kibanaPipeline.getOssCiGroupWorker(1),
|
||||
'oss-ciGroup2': kibanaPipeline.getOssCiGroupWorker(2),
|
||||
'oss-ciGroup3': kibanaPipeline.getOssCiGroupWorker(3),
|
||||
'oss-ciGroup4': kibanaPipeline.getOssCiGroupWorker(4),
|
||||
'oss-ciGroup5': kibanaPipeline.getOssCiGroupWorker(5),
|
||||
'oss-ciGroup6': kibanaPipeline.getOssCiGroupWorker(6),
|
||||
'oss-ciGroup7': kibanaPipeline.getOssCiGroupWorker(7),
|
||||
'oss-ciGroup8': kibanaPipeline.getOssCiGroupWorker(8),
|
||||
'oss-ciGroup9': kibanaPipeline.getOssCiGroupWorker(9),
|
||||
'oss-ciGroup10': kibanaPipeline.getOssCiGroupWorker(10),
|
||||
'oss-ciGroup11': kibanaPipeline.getOssCiGroupWorker(11),
|
||||
'oss-ciGroup12': kibanaPipeline.getOssCiGroupWorker(12),
|
||||
'oss-accessibility': kibanaPipeline.getPostBuildWorker('accessibility', { runbld('./test/scripts/jenkins_accessibility.sh', 'Execute kibana-accessibility') }),
|
||||
// 'oss-visualRegression': kibanaPipeline.getPostBuildWorker('visualRegression', { runbld('./test/scripts/jenkins_visual_regression.sh', 'Execute kibana-visualRegression') }),
|
||||
]),
|
||||
'kibana-xpack-agent': kibanaPipeline.withWorkers('kibana-xpack-tests', { kibanaPipeline.buildXpack() }, [
|
||||
'xpack-firefoxSmoke': kibanaPipeline.getPostBuildWorker('xpack-firefoxSmoke', { runbld('./test/scripts/jenkins_xpack_firefox_smoke.sh', 'Execute xpack-firefoxSmoke') }),
|
||||
'xpack-ciGroup1': kibanaPipeline.getXpackCiGroupWorker(1),
|
||||
'xpack-ciGroup2': kibanaPipeline.getXpackCiGroupWorker(2),
|
||||
'xpack-ciGroup3': kibanaPipeline.getXpackCiGroupWorker(3),
|
||||
'xpack-ciGroup4': kibanaPipeline.getXpackCiGroupWorker(4),
|
||||
'xpack-ciGroup5': kibanaPipeline.getXpackCiGroupWorker(5),
|
||||
'xpack-ciGroup6': kibanaPipeline.getXpackCiGroupWorker(6),
|
||||
'xpack-ciGroup7': kibanaPipeline.getXpackCiGroupWorker(7),
|
||||
'xpack-ciGroup8': kibanaPipeline.getXpackCiGroupWorker(8),
|
||||
'xpack-ciGroup9': kibanaPipeline.getXpackCiGroupWorker(9),
|
||||
'xpack-ciGroup10': kibanaPipeline.getXpackCiGroupWorker(10),
|
||||
'xpack-accessibility': kibanaPipeline.getPostBuildWorker('xpack-accessibility', { runbld('./test/scripts/jenkins_xpack_accessibility.sh', 'Execute xpack-accessibility') }),
|
||||
// 'xpack-visualRegression': kibanaPipeline.getPostBuildWorker('xpack-visualRegression', { runbld('./test/scripts/jenkins_xpack_visual_regression.sh', 'Execute xpack-visualRegression') }),
|
||||
]),
|
||||
])
|
||||
githubPr.withDefaultPrComments {
|
||||
catchError {
|
||||
parallel([
|
||||
'kibana-intake-agent': kibanaPipeline.legacyJobRunner('kibana-intake'),
|
||||
'x-pack-intake-agent': kibanaPipeline.legacyJobRunner('x-pack-intake'),
|
||||
'kibana-oss-agent': kibanaPipeline.withWorkers('kibana-oss-tests', { kibanaPipeline.buildOss() }, [
|
||||
'oss-firefoxSmoke': kibanaPipeline.getPostBuildWorker('firefoxSmoke', { runbld('./test/scripts/jenkins_firefox_smoke.sh', 'Execute kibana-firefoxSmoke') }),
|
||||
'oss-ciGroup1': kibanaPipeline.getOssCiGroupWorker(1),
|
||||
'oss-ciGroup2': kibanaPipeline.getOssCiGroupWorker(2),
|
||||
'oss-ciGroup3': kibanaPipeline.getOssCiGroupWorker(3),
|
||||
'oss-ciGroup4': kibanaPipeline.getOssCiGroupWorker(4),
|
||||
'oss-ciGroup5': kibanaPipeline.getOssCiGroupWorker(5),
|
||||
'oss-ciGroup6': kibanaPipeline.getOssCiGroupWorker(6),
|
||||
'oss-ciGroup7': kibanaPipeline.getOssCiGroupWorker(7),
|
||||
'oss-ciGroup8': kibanaPipeline.getOssCiGroupWorker(8),
|
||||
'oss-ciGroup9': kibanaPipeline.getOssCiGroupWorker(9),
|
||||
'oss-ciGroup10': kibanaPipeline.getOssCiGroupWorker(10),
|
||||
'oss-ciGroup11': kibanaPipeline.getOssCiGroupWorker(11),
|
||||
'oss-ciGroup12': kibanaPipeline.getOssCiGroupWorker(12),
|
||||
'oss-accessibility': kibanaPipeline.getPostBuildWorker('accessibility', { runbld('./test/scripts/jenkins_accessibility.sh', 'Execute kibana-accessibility') }),
|
||||
// 'oss-visualRegression': kibanaPipeline.getPostBuildWorker('visualRegression', { runbld('./test/scripts/jenkins_visual_regression.sh', 'Execute kibana-visualRegression') }),
|
||||
]),
|
||||
'kibana-xpack-agent': kibanaPipeline.withWorkers('kibana-xpack-tests', { kibanaPipeline.buildXpack() }, [
|
||||
'xpack-firefoxSmoke': kibanaPipeline.getPostBuildWorker('xpack-firefoxSmoke', { runbld('./test/scripts/jenkins_xpack_firefox_smoke.sh', 'Execute xpack-firefoxSmoke') }),
|
||||
'xpack-ciGroup1': kibanaPipeline.getXpackCiGroupWorker(1),
|
||||
'xpack-ciGroup2': kibanaPipeline.getXpackCiGroupWorker(2),
|
||||
'xpack-ciGroup3': kibanaPipeline.getXpackCiGroupWorker(3),
|
||||
'xpack-ciGroup4': kibanaPipeline.getXpackCiGroupWorker(4),
|
||||
'xpack-ciGroup5': kibanaPipeline.getXpackCiGroupWorker(5),
|
||||
'xpack-ciGroup6': kibanaPipeline.getXpackCiGroupWorker(6),
|
||||
'xpack-ciGroup7': kibanaPipeline.getXpackCiGroupWorker(7),
|
||||
'xpack-ciGroup8': kibanaPipeline.getXpackCiGroupWorker(8),
|
||||
'xpack-ciGroup9': kibanaPipeline.getXpackCiGroupWorker(9),
|
||||
'xpack-ciGroup10': kibanaPipeline.getXpackCiGroupWorker(10),
|
||||
'xpack-accessibility': kibanaPipeline.getPostBuildWorker('xpack-accessibility', { runbld('./test/scripts/jenkins_xpack_accessibility.sh', 'Execute xpack-accessibility') }),
|
||||
// 'xpack-visualRegression': kibanaPipeline.getPostBuildWorker('xpack-visualRegression', { runbld('./test/scripts/jenkins_xpack_visual_regression.sh', 'Execute xpack-visualRegression') }),
|
||||
]),
|
||||
])
|
||||
}
|
||||
}
|
||||
kibanaPipeline.sendMail()
|
||||
}
|
||||
|
|
|
|||
173
vars/githubPr.groovy
Normal file
173
vars/githubPr.groovy
Normal file
|
|
@ -0,0 +1,173 @@
|
|||
/**
|
||||
Wraps the main/important part of a job, executes it, and then publishes a comment to GitHub with the status.
|
||||
|
||||
It will check for the existence of GHPRB env variables before doing any actual PR work,
|
||||
so it can be used to wrap code that is executed in both PR and non-PR contexts.
|
||||
|
||||
Inside the comment, it will hide a JSON blob containing build data (status, etc).
|
||||
|
||||
Then, the next time it posts a comment, it will:
|
||||
1. Read the previous comment and parse the json
|
||||
2. Create a new comment, add a summary of up to 5 previous builds to it, and append this build's data to the hidden JSON
|
||||
3. Delete the old comment
|
||||
|
||||
So, there is only ever one build status comment on a PR at any given time, the most recent one.
|
||||
*/
|
||||
def withDefaultPrComments(closure) {
|
||||
catchError {
|
||||
catchError {
|
||||
closure()
|
||||
}
|
||||
|
||||
if (!params.ENABLE_GITHUB_PR_COMMENTS || !isPr()) {
|
||||
return
|
||||
}
|
||||
|
||||
def status = buildUtils.getBuildStatus()
|
||||
if (status == "ABORTED") {
|
||||
return;
|
||||
}
|
||||
|
||||
def lastComment = getLatestBuildComment()
|
||||
def info = getLatestBuildInfo(lastComment) ?: [:]
|
||||
info.builds = (info.builds ?: []).takeRight(5) // Rotate out old builds
|
||||
|
||||
def message = getNextCommentMessage(info)
|
||||
postComment(message)
|
||||
|
||||
if (lastComment) {
|
||||
deleteComment(lastComment.id)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Checks whether or not this currently executing build was triggered via a PR in the elastic/kibana repo
|
||||
def isPr() {
|
||||
return !!(env.ghprbPullId && env.ghprbPullLink && env.ghprbPullLink =~ /\/elastic\/kibana\//)
|
||||
}
|
||||
|
||||
def getLatestBuildComment() {
|
||||
return getComments()
|
||||
.reverse()
|
||||
.find { it.user.login == 'elasticmachine' && it.body =~ /<!--PIPELINE/ }
|
||||
}
|
||||
|
||||
def getBuildInfoFromComment(commentText) {
|
||||
def matches = commentText =~ /(?ms)<!--PIPELINE(.*?)PIPELINE-->/
|
||||
if (!matches || !matches[0]) {
|
||||
return null
|
||||
}
|
||||
|
||||
return toJSON(matches[0][1].trim())
|
||||
}
|
||||
|
||||
def getLatestBuildInfo() {
|
||||
return getLatestBuildInfo(getLatestBuildComment())
|
||||
}
|
||||
|
||||
def getLatestBuildInfo(comment) {
|
||||
return comment ? getBuildInfoFromComment(comment) : null
|
||||
}
|
||||
|
||||
def createBuildInfo() {
|
||||
return [
|
||||
status: buildUtils.getBuildStatus(),
|
||||
url: env.BUILD_URL,
|
||||
number: env.BUILD_NUMBER,
|
||||
commit: getCommitHash()
|
||||
]
|
||||
}
|
||||
|
||||
def getHistoryText(builds) {
|
||||
if (!builds || builds.size() < 1) {
|
||||
return ""
|
||||
}
|
||||
|
||||
def list = builds
|
||||
.reverse()
|
||||
.collect { build ->
|
||||
if (build.status == "SUCCESS") {
|
||||
return "* :green_heart: [Build #${build.number}](${build.url}) succeeded ${build.commit}"
|
||||
} else {
|
||||
return "* :broken_heart: [Build #${build.number}](${build.url}) failed ${build.commit}"
|
||||
}
|
||||
}
|
||||
.join("\n")
|
||||
|
||||
return "### History\n${list}"
|
||||
}
|
||||
|
||||
def getNextCommentMessage(previousCommentInfo = [:]) {
|
||||
info = previousCommentInfo ?: [:]
|
||||
info.builds = previousCommentInfo.builds ?: []
|
||||
|
||||
def messages = []
|
||||
|
||||
if (buildUtils.getBuildStatus() == 'SUCCESS') {
|
||||
messages << """
|
||||
## :green_heart: Build Succeeded
|
||||
* [continuous-integration/kibana-ci/pull-request](${env.BUILD_URL})
|
||||
* Commit: ${getCommitHash()}
|
||||
"""
|
||||
} else {
|
||||
messages << """
|
||||
## :broken_heart: Build Failed
|
||||
* [continuous-integration/kibana-ci/pull-request](${env.BUILD_URL})
|
||||
* Commit: ${getCommitHash()}
|
||||
"""
|
||||
}
|
||||
|
||||
if (info.builds && info.builds.size() > 0) {
|
||||
messages << getHistoryText(info.builds)
|
||||
}
|
||||
|
||||
messages << "To update your PR or re-run it, just comment with:\n`@elasticmachine merge upstream`"
|
||||
|
||||
info.builds << createBuildInfo()
|
||||
|
||||
messages << """
|
||||
<!--PIPELINE
|
||||
${toJSON(info).toString()}
|
||||
PIPELINE-->
|
||||
"""
|
||||
|
||||
return messages
|
||||
.findAll { !!it } // No blank strings
|
||||
.collect { it.stripIndent().trim() }
|
||||
.join("\n\n")
|
||||
}
|
||||
|
||||
def withGithubCredentials(closure) {
|
||||
withCredentials([
|
||||
string(credentialsId: '2a9602aa-ab9f-4e52-baf3-b71ca88469c7', variable: 'GITHUB_TOKEN'),
|
||||
]) {
|
||||
closure()
|
||||
}
|
||||
}
|
||||
|
||||
def postComment(message) {
|
||||
if (!isPr()) {
|
||||
error "Trying to post a GitHub PR comment on a non-PR or non-elastic PR build"
|
||||
}
|
||||
|
||||
withGithubCredentials {
|
||||
return githubApi.post("repos/elastic/kibana/issues/${env.ghprbPullId}/comments", [ body: message ])
|
||||
}
|
||||
}
|
||||
|
||||
def getComments() {
|
||||
withGithubCredentials {
|
||||
return githubIssues.getComments(env.ghprbPullId)
|
||||
}
|
||||
}
|
||||
|
||||
def deleteComment(commentId) {
|
||||
withGithubCredentials {
|
||||
def path = "repos/elastic/kibana/issues/comments/${commentId}"
|
||||
return githubApi([ path: path ], [ method: "DELETE" ])
|
||||
}
|
||||
}
|
||||
|
||||
def getCommitHash() {
|
||||
return env.ghprbActualCommit
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue