post release v1.49.0: update major branch

.buildkite/README.md

@@ -9,7 +9,7 @@ This is the Buildkite pipeline for releasing the APM Agent Java.
 ### Pipeline Configuration
 
 To view the pipeline and its configuration, click [here](https://buildkite.com/elastic/apm-agent-java-release) or
-go to the definition in the `elastic/ci` repository.
+go to the definition in `release.yml`.
 
 ### Credentials
 
@@ -25,7 +25,7 @@ This is the Buildkite pipeline for the APM Agent Java in charge of the snapshots
 ### Pipeline Configuration
 
 To view the pipeline and its configuration, click [here](https://buildkite.com/elastic/apm-agent-java-snapshot) or
-go to the definition in the `elastic/ci` repository.
+go to the definition in `snapshot.yml`.
 
 ## opentelemetry-benchmark pipeline
 
@@ -35,3 +35,15 @@ This is the Buildkite pipeline for the Opentelemetry Benchmark.
 
 To view the pipeline and its configuration, click [here](https://buildkite.com/elastic/apm-agent-java-opentelemetry-benchmark) or
 go to the definition in `opentelemetry-benchmark.yml`.
+
+## Buildkite VM runners
+
+A set of Buildkite VM runners has been created for this repository. The VM runners contain
+the required software:
+* JDK
+* GPG
+* Maven dependencies
+
+If a new version of Java is required, update the `.java-version` file with the latest major. When the changes are merged onto `main,` wait for the following day; that's when the automation will be responsible for recreating the VM with the new Java version.
+
+If you would like to know more about how it works, please go to https://github.com/elastic/ci-agent-images/tree/main/vm-images/apm-agent-java (**NOTE**: only available for Elastic employees)

.buildkite/hooks/prepare-common.sh

@@ -1,17 +1,27 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
-echo "--- Install JDK17 :java:"
-# JDK version is defined in two different locations, here and .github/workflows/maven-goal/action.yml
-JAVA_URL=https://jvm-catalog.elastic.co/jdk
-JAVA_HOME=$(pwd)/.openjdk17
-JAVA_PKG="$JAVA_URL/latest_openjdk_17_linux.tar.gz"
-curl -L --output /tmp/jdk.tar.gz "$JAVA_PKG"
-mkdir -p "$JAVA_HOME"
-tar --extract --file /tmp/jdk.tar.gz --directory "$JAVA_HOME" --strip-components 1
-
+# Configure the java version
+JAVA_VERSION=$(cat .java-version | xargs | tr -dc '[:print:]')
+JAVA_HOME="${HOME}/.java/openjdk${JAVA_VERSION}"
 export JAVA_HOME
-PATH=$JAVA_HOME/bin:$PATH
+PATH="${JAVA_HOME}/bin:${PATH}"
 export PATH
 
-java -version || true
+if [ -d "${JAVA_HOME}" ] ; then
+  echo "--- Skip installing JDK${JAVA_VERSION} :java:"
+  echo "already available in the Buildkite runner"
+else
+  # Fallback to install at runtime
+  # This should not be the case normally untless the .java-version file has been changed
+  # and the VM Image is not yet available with the latest version.
+  echo "--- Install JDK${JAVA_VERSION} :java:"
+  JAVA_URL=https://jvm-catalog.elastic.co/jdk
+  JAVA_PKG="${JAVA_URL}/latest_openjdk_${JAVA_VERSION}_linux.tar.gz"
+  curl -L --output /tmp/jdk.tar.gz "${JAVA_PKG}"
+  mkdir -p "${JAVA_HOME}"
+  tar --extract --file /tmp/jdk.tar.gz --directory "${JAVA_HOME}" --strip-components 1
+fi
+
+# Validate java is available in the runner.
+java -version

.buildkite/release.yml

@@ -1,5 +1,6 @@
 agents:
   provider: "gcp"
+  image: "family/apm-agent-java-ubuntu-2204"
 
 steps:
   - label: "Run the release"
@@ -11,4 +12,5 @@ steps:
 
 notify:
   - slack: "#apm-agent-java"
-    if: 'build.state != "passed"'
+    # skip slack messages if no failures and dry-run mode
+    if: 'build.state != "passed" && build.env("dry_run") == "false"'

.buildkite/snapshot.yml

@@ -1,5 +1,6 @@
 agents:
   provider: "gcp"
+  image: "family/apm-agent-java-ubuntu-2204"
 
 steps:
   - label: "Run the snapshot"
@@ -11,4 +12,5 @@ steps:
 
 notify:
   - slack: "#apm-agent-java"
-    if: 'build.state != "passed"'
+    # skip slack messages if no failures and dry-run mode
+    if: 'build.state != "passed" && build.env("dry_run") == "false"'

.ci/release.sh

@@ -21,5 +21,14 @@ echo $PATH
 java -version
 
 set +x
-echo "--- Deploy the release :package:"
-./mvnw -V -s .ci/settings.xml -Pgpg clean deploy -DskipTests --batch-mode | tee release.txt
+# Default in dry-run mode
+GOAL="install"
+DRY_RUN_MSG="(dry-run)"
+# Otherwise, a RELEASE
+if [[ "$dry_run" == "false" ]] ; then
+  GOAL="deploy"
+  DRY_RUN_MSG=""
+fi
+
+echo "--- Deploy the release :package: [./mvnw $GOAL)] $DRY_RUN_MSG"
+./mvnw -V -s .ci/settings.xml -Pgpg clean $GOAL -DskipTests --batch-mode | tee release.txt

.ci/release/post-release.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+# Bash strict mode
+set -euo pipefail
+
+# Found current script directory
+RELATIVE_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+# Found project directory
+BASE_PROJECT="$(dirname $(dirname "${RELATIVE_DIR}"))"
+
+# Import dependencies
+source "${RELATIVE_DIR}/util.sh"
+
+# Constants
+BASE_URL="https://repo1.maven.org/maven2/co/elastic/apm/elastic-apm-agent"
+CF_FILE="${BASE_PROJECT}/cloudfoundry/index.yml"
+
+# Requirements
+check_version "${RELEASE_VERSION}"
+
+echo "Set next snapshot version"
+./mvnw -V versions:set -DprocessAllModules=true -DgenerateBackupPoms=false -DnextSnapshot=true
+
+# make script idempotent if release is already in CF descriptor
+set +e
+grep -e "^${RELEASE_VERSION}:" ${CF_FILE}
+[[ $? == 0 ]] && exit 0
+set -e
+echo "Update cloudfoundry version"
+echo "${RELEASE_VERSION}: ${BASE_URL}/${RELEASE_VERSION}/elastic-apm-agent-${RELEASE_VERSION}.jar" >> "${CF_FILE}"

.ci/release/pre-release.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+# Bash strict mode
+set -euo pipefail
+
+# Found current script directory
+RELATIVE_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+# Found project directory
+BASE_PROJECT="$(dirname $(dirname "${RELATIVE_DIR}"))"
+
+# Import dependencies
+source "${RELATIVE_DIR}/util.sh"
+
+# Requirements
+check_version "${RELEASE_VERSION}"
+
+echo "Set release version"
+./mvnw -V versions:set -DprocessAllModules=true -DgenerateBackupPoms=false -DnewVersion="${RELEASE_VERSION}"
+
+echo "Prepare changelog for release"
+java "${BASE_PROJECT}/.ci/ReleaseChangelog.java" CHANGELOG.asciidoc "${RELEASE_VERSION}"

.ci/release/update_major_branch.sh → .ci/release/update-major-branch.sh

@@ -62,3 +62,10 @@ git checkout --force ${checkout_options}
 
 echo -e "\n--- move local branch ${major_branch} to match tag ${tag}"
 git reset --hard ${tag}
+
+echo -e "\n--- create new branch with updates"
+git checkout -b "update-major-${v}"
+git push origin "update-major-${v}"
+
+echo -e "\n--- create PR to update major branch"
+gh pr create --title="post release v${v}: update major branch" --base "${major_branch}" --head "update-major-${v}" -b "post release v${v}"

.ci/release/util.sh

@@ -3,14 +3,12 @@
 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'"
+  if [ -z "${v}" ]; then
+    >&2 echo "The environment variable 'RELEASE_VERSION' isn't defined"
     exit 1
   fi
-
-  if [[ ! "$v" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
-    echo "invalid version format '${v}'"
+  if [[ ! "${v}" =~ ^([0-9]+)\.([0-9]+)\.([0-9]+)$ ]]; then
+    >&2 echo "The environment variable 'RELEASE_VERSION' should respect SemVer format"
     exit 1
   fi
 }

.ci/snapshot.sh

@@ -23,9 +23,14 @@ echo $PATH
 java -version
 
 set +x
-echo "--- Deploy the snapshot :package:"
-if [[ "$dry_run" == "true" ]] ; then
-  echo './mvnw -V -s .ci/settings.xml -Pgpg clean deploy -DskipTests --batch-mode'
-else
-  ./mvnw -V -s .ci/settings.xml -Pgpg clean deploy -DskipTests --batch-mode | tee snapshot.txt
+# Default in dry-run mode
+GOAL="install"
+DRY_RUN_MSG="(dry-run)"
+# Otherwise, a snapshot
+if [[ "$dry_run" == "false" ]] ; then
+  GOAL="deploy"
+  DRY_RUN_MSG=""
 fi
+
+echo "--- Deploy the snapshot :package: [./mvnw $GOAL)] $DRY_RUN_MSG"
+./mvnw -V -s .ci/settings.xml -Pgpg clean $GOAL -DskipTests --batch-mode | tee snapshot.txt

.github/workflows/README.md

@@ -35,8 +35,12 @@ Every time there is a merge to main or any branches the whole workflow will comp
 
 ### Release process
 
-This process has been fully automated and it gets triggered manually when running the [release](https://github.com/elastic/apm-agent-java/actions/workflows/release.yml) workflow. It runs then a Buildkite pipeline in charge of generating and publishing the artifacts,
+To release a new version of apm-agent-java, you must use the two GitHub Workflows.
+Trigger the `Pre Release` workflow targeting the release version.
+After merging the PRs created by the first workflow, you can trigger the `Release` workflow targeting the release version.
+It runs then a Buildkite pipeline in charge of generating and publishing the artifacts,
 for further details please go to [the buildkite folder](../../.buildkite/README.md).
+Finally, merge the PRs created to bump version for the next iteration.
 
 The tag release follows the naming convention: `v.<major>.<minor>.<patch>`, where `<major>`, `<minor>` and `<patch>`.
 

.github/workflows/addToProject.yml

@@ -3,6 +3,9 @@ on:
   issues:
     types:
       - opened, milestoned
+permissions:
+  contents: read
+
 jobs:
   add_to_project:
     if: github.event.issue && github.event.issue.milestone

.github/workflows/labeler.yml

@@ -5,6 +5,11 @@ on:
   pull_request_target:
     types: [opened]
 
+permissions:
+  contents: read
+  issues: write
+  pull-requests: write
+
 jobs:
   triage:
     runs-on: ubuntu-latest

.github/workflows/main.yml

@@ -305,7 +305,7 @@ jobs:
             distribution: 'temurin'
     steps:
       - uses: actions/checkout@v4
-      - uses: ./.github/workflows/maven-goal
+      - uses: ./.github/workflows/maven-goal-jdk
         with:
           test-java-version: ${{ matrix.version }}
           test-java-distribution: ${{ matrix.distribution }}

.github/workflows/maven-goal-jdk/action.yml

@@ -0,0 +1,44 @@
+---
+
+name: common build tasks
+description: Install specific JDK and run a command
+
+inputs:
+  test-java-version:
+    description: 'Testing Java version'
+    required: true
+    default: '17'
+  test-java-distribution:
+    description: 'Testing Java distribution'
+    required: true
+    default: 'temurin'
+  command:
+    description: 'Command to execute'
+    required: true
+  shell:
+    description: 'Default shell'
+    default: 'bash'
+    required: false
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set up testing JDK
+      uses: actions/setup-java@v4
+      with:
+        java-version: ${{ inputs.test-java-version}}
+        distribution: ${{ inputs.test-java-distribution}}
+
+    - name: Set up TEST_JAVA_BINARY environment variable
+      shell: bash
+      run: |
+        major_version="$(echo '${{ inputs.test-java-version }}' | sed 's/\([0-9]*\).*/\1/')"
+        java_home_var=JAVA_HOME_${major_version}_${{ runner.arch }}
+        echo "TEST_JAVA_BINARY=${!java_home_var}/bin/java" >> $GITHUB_ENV
+
+    - uses: ./.github/workflows/maven-goal
+      with:
+        command: ${{ inputs.command }}
+        shell: ${{ inputs.shell }}
+      env:
+        TEST_JAVA_BINARY: ${{ env.TEST_JAVA_BINARY }}

.github/workflows/maven-goal/action.yml

@@ -4,14 +4,6 @@ name: common build tasks
 description: Install specific JDK and run a command
 
 inputs:
-  test-java-version:
-    description: 'Testing Java version'
-    required: true
-    default: '17'
-  test-java-distribution:
-    description: 'Testing Java distribution'
-    required: true
-    default: 'temurin'
   command:
     description: 'Command to execute'
     required: true
@@ -23,23 +15,11 @@ inputs:
 runs:
   using: "composite"
   steps:
-    - name: Set up testing JDK
-      if: ${{ inputs.test-java-version != '17' }}
-      uses: actions/setup-java@v4
-      with:
-        java-version: ${{ inputs.test-java-version}}
-        distribution: ${{ inputs.test-java-distribution}}
     - name: Set up build JDK
       uses: actions/setup-java@v4
       with:
-        java-version: 17 # NOTE: This version is also defined in .buildkite/hooks/pre-command
+        java-version-file: .java-version
         distribution: temurin
         cache: 'maven'
-    - name: Set up TEST_JAVA_BINARY environment variable
-      shell: bash
-      run: |
-        major_version="$(echo '${{ inputs.test-java-version }}' | sed 's/\([0-9]*\).*/\1/')"
-        java_home_var=JAVA_HOME_${major_version}_${{ runner.arch }}
-        echo "TEST_JAVA_BINARY=${!java_home_var}/bin/java" >> $GITHUB_ENV
     - run: ${{ inputs.command }}
       shell: ${{ inputs.shell }}