[release] fix+refactor major branch update (#2302)

SylvainJuge · v1v · web-flow · commit ed4309e6a4c3 · 2021-12-02T10:12:20.000+01:00
* fix all the things

* fix typos

* fix another typo

* re-enable disabled steps

* refactor few other steps + re-enable steps

* fix typo

* further cleanup

* Update .ci/release/Jenkinsfile

Co-authored-by: Victor Martinez &lt;victormartinezrubio@gmail.com&gt;

Co-authored-by: Victor Martinez &lt;victormartinezrubio@gmail.com&gt;
diff --git a/.ci/release/Jenkinsfile b/.ci/release/Jenkinsfile
@@ -64,7 +64,6 @@ pipeline {
       options { skipDefaultCheckout () }
       stages{
         stage('Check oss.sonatype.org') {
-          when {expression { return false }}
           steps {
             // If this fails, an exception should be thrown and execution will halt
             dir("${BASE_DIR}"){
@@ -80,7 +79,6 @@ pipeline {
         stage('Check build status') {
           when {
             allOf {
-              expression { return false }
               expression { params.check_branch_ci_status }
               expression { env.BRANCH_SPECIFIER != 'stable' }
             }
@@ -95,7 +93,6 @@ pipeline {
           }
         }
         stage('Require confirmation that CHANGELOG.asciidoc has been updated') {
-          when {expression { return false }}
           steps {
             input(message: """
             Update CHANGELOG.asciidoc to reflect the new version release:
@@ -139,67 +136,30 @@ pipeline {
             }
           }
         }
-
-        // temporary allow to override version
-        stage('Set release version manually') {
-          steps {
-            dir("${BASE_DIR}"){
-              script {
-                def user_release_version = input(message: "Please enter version to release:", parameters: [[
-                    $class: 'StringParameterDefinition',
-                    name: 'Release version',
-                    defaultValue: "",
-                    description: "Input release version without '-SNAPSHOT' suffix"
-                  ]])
-
-                env.RELEASE_TAG = "v" + user_release_version
-                env.RELEASE_VERSION = user_release_version
-                env.BRANCH_DOT_X = user_release_version.substring(0, user_release_version.indexOf('.'))+'.x'
-              }
-            }
-          }
-        }
-
         stage('Wait on internal CI') {
-          when {expression { return false }}
           steps {
             notifyStatus(slackStatus: 'warning', subject: "[${env.REPO}] Release ready to be pushed",
                           body: "Please go to (<${env.BUILD_URL}input|here>) to approve or reject within 12 hours.")
             input(message: "Start the release job on the internal CI. Click 'Proceed' once the job has succeeded or click 'Abort' if the release has failed and then manually undo the release.")
           }
         }
         stage('Nexus release') {
-          when {expression { return false }}
           steps {
             notifyStatus(slackStatus: 'warning', subject: "[${env.REPO}] Release ready to be published in Nexus",
                          body: "Please go to (<https://oss.sonatype.org/|here>) to proceed with the manual nexus release. Login details in LastPass")
             input(message: "Go to https://oss.sonatype.org and proceed with the steps to close and release the staging artifact.")
           }
         }
         stage('Major Branch create/update') {
-          when {expression { return false }}
           steps {
             dir("${BASE_DIR}") {
               script {
+                sh(script: ".ci/release/update_major_branch.sh ${RELEASE_VERSION}")
+                gitPush(args: "-f ${BRANCH_DOT_X}")
+
                 def isMajor = env.RELEASE_VERSION.endsWith(".0.0")
                 if (isMajor) {
-                  // major release, create '.x' branch
-                  sh(label: "remote tag is fetched for local checkout", script: "git fetch origin ${RELEASE_TAG}")
-                  sh(label: "create .x branch from ${RELEASE_TAG}", script: """
-                    git checkout ${RELEASE_TAG} --force
-                    git checkout -b ${BRANCH_DOT_X} --force""")
-                  gitPush()
                   input message: "This was a major version release. Please update the conf.yml in the docs repo before continuing", ok "Continue"
-                } else {
-                  // minor release, force-update existing '.x' branch. any change applied to '.x' branch, for example to
-                  // fix doc or release notes should also have been applied to master/stable branch we are releasing from
-                  sh(label: "remote tag and branch are fetched for local checkout", script: """
-                    git fetch origin ${BRANCH_DOT_X}
-                    git fetch origin ${RELEASE_TAG}""")
-                  sh(label: "force-update .x branch from ${RELEASE_TAG}", script: """
-                    git checkout --track origin/${BRANCH_DOT_X} --force
-                    git reset --hard origin/${RELEASE_TAG}""")
-                  gitPush(args: "-f ${BRANCH_DOT_X}")
                 }
               }
             }
@@ -228,10 +188,9 @@ pipeline {
           steps {
             dir("${BASE_DIR}"){
               script {
-                def fullUrl = "https://repo1.maven.org/maven2/co/elastic/apm/elastic-apm-agent/${RELEASE_VERSION}/elastic-apm-agent-${RELEASE_VERSION}.pom"
                 waitUntil(initialRecurrencePeriod: 60000) {
                   script {
-                    def ret = sh(script: "curl -fs '${fullUrl}' >/dev/null 2>&1", returnStatus: true)
+                    def ret = sh(script: ".ci/release/wait_maven_artifact_published.sh ${RELEASE_VERSION}", returnStatus: true)
                     echo "Waiting for the artifacts to be published on Sonatype"
                     return ret == 0
                   }
@@ -243,12 +202,7 @@ pipeline {
         stage('Update Cloudfoundry') {
           steps {
             dir("${BASE_DIR}"){
-              // ensure that we don't rely on side effect of another step
-              sh(label: "restore to previous updating version", script: """
-                  git fetch origin master
-                  git checkout master
-                  git reset --hard origin/master""")
-              sh(script: "./scripts/jenkins/update_cloudfoundry.sh ${RELEASE_VERSION}")
+              sh(script: ".ci/release/update_cloudfoundry.sh ${RELEASE_VERSION}")
               gitPush()
             }
           }
@@ -259,7 +213,7 @@ pipeline {
               waitUntil(initialRecurrencePeriod: 60000) {
                 script {
                   echo "Waiting for the release notes to be available"
-                    def ret = sh(script: "curl -fs https://www.elastic.co/guide/en/apm/agent/java/current/release-notes-${BRANCH_DOT_X}.html | grep ${RELEASE_VERSION}", returnStatus: true)
+                    def ret = sh(script: ".ci/release/wait_release_notes_published.sh ${RELEASE_VERSION}", returnStatus: true)
                     return ret == 0
                 }
               }
@@ -282,7 +236,7 @@ pipeline {
           }
           post {
             success {
-              notifyStatus(slackStatus: 'good', subject: "[${env.REPO}] Release published", body: "Great news! The release has completed successfully. (<${env.RUN_DISPLAY_URL}|Open>).")
+              notifyStatus(slackStatus: 'good', subject: "[${env.REPO}] Release published", body: "Great news! The release ${env.RELEASE_VERSION} has completed successfully. (<${env.RUN_DISPLAY_URL}|Open>).")
             }
           }
         }
diff --git a/.ci/release/update_cloudfoundry.sh b/.ci/release/update_cloudfoundry.sh
@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+source "$(dirname "${0}")/util.sh"
+
+REMOTE_NAME=origin
+BRANCH_NAME=master
+BASE_URL=https://repo1.maven.org/maven2/co/elastic/apm/elastic-apm-agent
+CF_FILE=cloudfoundry/index.yml
+
+check_version "${1:-}"
+v="${1:-}"
+
+echo -e "\n--- fetch & ensure clean state of ${REMOTE_NAME}/${BRANCH_NAME}"
+git fetch ${REMOTE_NAME} ${BRANCH_NAME}
+git checkout ${BRANCH_NAME}
+git reset --hard ${REMOTE_NAME}/${BRANCH_NAME}
+
+echo -e "\n--- update ${CF_FILE} if required"
+
+# make script idempotent if release is already in CF descriptor
+set +e
+grep -e "^${v}:" ${CF_FILE}
+[[ $? == 0 ]] && exit 0
+set -e
+
+echo "${v}: ${BASE_URL}/${v}/elastic-apm-agent-${v}.jar" >> ${CF_FILE}
+git commit ${CF_FILE} -m "Update cloudfoundry for ${v} release"
diff --git a/.ci/release/update_major_branch.sh b/.ci/release/update_major_branch.sh
@@ -0,0 +1,64 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+source "$(dirname "${0}")/util.sh"
+
+REMOTE_NAME=origin
+
+# Final state (when there is no error): local checkout in the major branch '1.x' that matches the release tag
+# Pushing to remote repository is managed by the caller
+
+check_version "${1:-}"
+v="${1:-}"
+
+tag=$(version_tag ${v})
+major_branch="$(version_major_branch "${v}")"
+
+echo ""
+echo "release version: ${v}"
+echo "release tag:     ${tag}"
+echo "major branch:    ${major_branch}"
+
+check_ref_exists () {
+  set +e
+  git show-ref --verify --quiet "${1}" \
+    && echo 1 \
+    || echo 0
+  set -e
+}
+
+
+# shallow clone does not allow to use other branches by default
+# found in https://stackoverflow.com/questions/23708231/git-shallow-clone-clone-depth-misses-remote-branches
+git remote set-branches ${REMOTE_NAME} '*'
+
+echo -e "\n--- delete any local ${major_branch} branch if it exists"
+set +e
+git rev-parse --verify ${major_branch} 2>/dev/null && git branch -D ${major_branch}
+set -e
+
+echo -e "\n--- ensure remote tag ${tag} and branch ${major_branch} are fetched for local checkout"
+git fetch --tags ${REMOTE_NAME}
+
+if [[ '1' != $(check_ref_exists "refs/tags/${tag}") ]]; then
+  echo "ERROR remote tag '${tag}' does not exists on remote '${REMOTE_NAME}'"
+  exit 1
+fi
+
+checkout_options=''
+
+echo -e "\n--- checkout or create ${major_branch} branch"
+if [[ "0" == "$(check_ref_exists "refs/remotes/${REMOTE_NAME}/${major_branch}")" ]]; then
+  # remote branch does not exists, creating new local branch
+  checkout_options="-b ${major_branch}"
+else
+  # remote branch exists, create local branch to update it
+  checkout_options="--track ${REMOTE_NAME}/${major_branch}"
+fi
+set -e
+
+echo -e "\n--- checkout local ${major_branch} branch"
+git checkout --force ${checkout_options}
+
+echo -e "\n--- move local branch ${major_branch} to match tag ${tag}"
+git reset --hard ${tag}
diff --git a/.ci/release/util.sh b/.ci/release/util.sh
@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+check_version() {
+  v=${1:-}
+
+  if [[ "${v}" == "" ]]; then
+    echo "usage $0 <version>" # here $0 will be the calling script
+    echo "where <version> in format '1.2.3'"
+    exit 1
+  fi
+
+  if [[ ! "$v" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+    echo "invalid version format '${v}'"
+    exit 1
+  fi
+}
+
+version_tag() {
+    echo "v${1:?usage version_tag <version>}"
+}
+
+version_major_branch() {
+  v="${1:?usage version_major_branch <version>}"
+  echo "${v%%.*}.x"
+}
diff --git a/.ci/release/wait_maven_artifact_published.sh b/.ci/release/wait_maven_artifact_published.sh
@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+source "$(dirname "${0}")/util.sh"
+
+# returns '0' (zero) status code when artifact exists
+# return non-zero status when artifact does not exists or unable to execute request
+
+check_version "${1:-}"
+v="${1:-}"
+
+full_url="https://repo1.maven.org/maven2/co/elastic/apm/elastic-apm-agent/${v}/elastic-apm-agent-${v}.pom"
+curl -fs "${full_url}" 2>&1 > /dev/null
diff --git a/.ci/release/wait_release_notes_published.sh b/.ci/release/wait_release_notes_published.sh
@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+source "$(dirname "${0}")/util.sh"
+
+# returns '0' (zero) status code when release notes have been published
+# return non-zero status when they haven't been published yet or unable to execute request
+
+check_version "${1:-}"
+v="${1:-}"
+major_branch="$(version_major_branch "${v}")"
+
+full_url="https://www.elastic.co/guide/en/apm/agent/java/current/release-notes-${major_branch}.html"
+curl -fs "${full_url}" | grep "${v}"
diff --git a/scripts/jenkins/update_cloudfoundry.sh b/scripts/jenkins/update_cloudfoundry.sh
