Main to 0.x

.github/workflows/addToProject.yml

@@ -6,6 +6,9 @@ on:
 env:
   MY_GITHUB_TOKEN: ${{ secrets.APM_TECH_USER_TOKEN }}
 
+permissions:
+  contents: read
+
 jobs:
   assign_one_project:
     runs-on: ubuntu-latest

.github/workflows/labeler.yml

@@ -6,6 +6,11 @@ on:
     types: [opened]
 env:
   MY_GITHUB_TOKEN: ${{ secrets.APM_TECH_USER_TOKEN }}
+permissions:
+  contents: read
+  issues: write
+  pull-requests: write
+
 jobs:
   triage:
     runs-on: ubuntu-latest

.github/workflows/opentelemetry.yml

@@ -1,15 +1,16 @@
 ---
+# Look up results at https://ela.st/oblt-ci-cd-stats
+# There will be one service per GitHub repository, including the org name, and one Transaction per Workflow.
 name: OpenTelemetry Export Trace
 
 on:
   workflow_run:
-    workflows:
-      - Continous Integration
-      - release
-      - snapshoty
-      - test-reporter
+    workflows: [ "*" ]
     types: [completed]
 
+permissions:
+  contents: read
+
 jobs:
   otel-export-trace:
     runs-on: ubuntu-latest

.github/workflows/release.yml

@@ -40,6 +40,18 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      - id: notification
+        name: Notify that a release will start
+        uses: elastic/apm-pipeline-library/.github/actions/slack-message@current
+        with:
+          url: ${{ secrets.VAULT_ADDR }}
+          roleId: ${{ secrets.VAULT_ROLE_ID }}
+          secretId: ${{ secrets.VAULT_SECRET_ID }}
+          channel: "#apm-agent-mobile"
+          message: |
+            :runner: [${{ github.repository }}] Release *${{ github.ref_name }}* has been triggered with the following params:
+            ```${{ toJSON(github.event.inputs) }}```
+
       - id: buildkite
         name: Run Release
         uses: elastic/apm-pipeline-library/.github/actions/buildkite@current
@@ -64,7 +76,7 @@ jobs:
           secretId: ${{ secrets.VAULT_SECRET_ID }}
           channel: "#apm-agent-mobile"
           message: |
-            :runner: [${{ github.repository }}] Release *${{ github.ref_name }}* has been triggered in Buildkite: (<${{ steps.buildkite.outputs.build }}|build>)
+            :tada: :rocket: [${{ github.repository }}] Release *${{ github.ref_name }}* has been successful in Buildkite: (<${{ steps.buildkite.outputs.build }}|build>)
 
       - if: ${{ failure() }}
         uses: elastic/apm-pipeline-library/.github/actions/slack-message@current

.github/workflows/test-reporter.yml

@@ -10,6 +10,11 @@ on:
     types:
       - completed
 
+permissions:
+  contents: read
+  actions: read
+  checks: write
+
 jobs:
   report:
     runs-on: ubuntu-latest

.github/workflows/updateVersionBranch.yml

@@ -0,0 +1,40 @@
+name: Update version branch
+
+#When a release is done, this creates a PR from main to the released version branch to keep it updated.
+#For example, if version "0.1.0" is released off of the main branch, then a PR from "main" to "0.x" will be created right after the release post-deploy is done.
+
+on:
+  pull_request:
+    types:
+      - closed
+
+permissions:
+  contents: read
+
+jobs:
+  if_merged_postDeploy:
+    if: github.event.pull_request.merged == true && startsWith(github.event.pull_request.head.ref, 'post-release/')
+    runs-on: ubuntu-latest
+    name: Create PR to update version branch
+    steps:
+      - uses: elastic/apm-pipeline-library/.github/actions/github-token@current
+        with:
+          url: ${{ secrets.VAULT_ADDR }}
+          roleId: ${{ secrets.VAULT_ROLE_ID }}
+          secretId: ${{ secrets.VAULT_SECRET_ID }}
+      - uses: elastic/apm-pipeline-library/.github/actions/setup-git@current
+        with:
+          username: ${{ env.GIT_USER }}
+          email: ${{ env.GIT_EMAIL }}
+          token: ${{ env.GITHUB_TOKEN }}
+      - uses: actions/checkout@v4
+      - uses: actions-ecosystem/action-regex-match@v2
+        id: major-version
+        with:
+          text: ${{ github.event.pull_request.head.ref }}
+          regex: 'post-release/(\d+).+'
+
+      - run: gh pr create --base ${{ env.BASE_BRANCH }} --title 'Merge main into version branch' --body 'Created by Github action' --reviewer elastic/apm-agent-android
+        env:
+          GH_TOKEN: ${{ env.GITHUB_TOKEN }}
+          BASE_BRANCH: "${{ steps.major-version.outputs.group1 }}.x"

build-tools/src/main/java/co/elastic/apm/compile/tools/publishing/ApmPublisherRootPlugin.java

@@ -3,8 +3,10 @@
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
 import org.gradle.api.plugins.PluginContainer;
+import org.gradle.util.internal.VersionNumber;
 
 import java.time.Duration;
+import java.util.regex.Pattern;
 
 import co.elastic.apm.compile.tools.NoticeProviderPlugin;
 import co.elastic.apm.compile.tools.plugins.RootNoticeProviderPlugin;
@@ -35,12 +37,29 @@ public void apply(Project project) {
     private void configureVersion(Project project) {
         String versionOverride = getVersionOverride(project);
         if (versionOverride != null) {
+            validateVersionOverrideFormatting(versionOverride);
+            validateVersionPatchChangeOnly(project.getVersion().toString(), versionOverride);
             System.out.println("Overriding version with: '" + versionOverride + "'");
             project.setVersion(versionOverride);
             project.subprojects(subproject -> subproject.setVersion(versionOverride));
         }
     }
 
+    private static void validateVersionPatchChangeOnly(String currentVersion, String versionOverride) {
+        VersionNumber comparableVersion = VersionNumber.parse(currentVersion);
+        VersionNumber comparableVersionOverride = VersionNumber.parse(versionOverride);
+        if (comparableVersionOverride.getMajor() > comparableVersion.getMajor() || comparableVersionOverride.getMinor() > comparableVersion.getMinor()) {
+            throw new IllegalArgumentException(String.format("The version override, '%s', cannot provide greater major or minor numbers than the existing version from the gradle.properties file: '%s'.", versionOverride, currentVersion));
+        }
+    }
+
+    private static void validateVersionOverrideFormatting(String versionOverride) {
+        Pattern semverPattern = Pattern.compile("\\d+\\.\\d+\\.\\d+");
+        if (!semverPattern.matcher(versionOverride).matches()) {
+            throw new IllegalArgumentException(String.format("The provided version override, '%s', does not have a valid format.", versionOverride));
+        }
+    }
+
     private String getVersionOverride(Project project) {
         if (!project.hasProperty(PROPERTY_VERSION_OVERRIDE)) {
             return null;

build-tools/src/main/java/co/elastic/apm/compile/tools/publishing/tasks/PostDeployTask.java

@@ -46,6 +46,7 @@ public void execute() {
 
         updateNextVersion(gradlePropertiesFile, properties, newVersion);
         updateChangelog(currentVersion);
+        updateSetupDoc(currentVersion);
 
         createPullRequestWithChanges(currentVersion);
         setGitHubRelease(currentVersion, releaseTag);
@@ -85,12 +86,23 @@ private void updateNextVersion(File gradlePropertiesFile, Properties properties,
 
     private void updateChangelog(String newVersion) {
         log("Updating changelog with version: " + newVersion);
-        Path changelogPath = getChangelogPath();
+        Path changelogPath = getProjectPath("CHANGELOG.asciidoc");
         String contents = getContents(changelogPath);
         contents = uncommentNextRelease(contents);
         replaceFileContents(changelogPath, resolvePlaceholders(contents, newVersion));
     }
 
+    private void updateSetupDoc(String currentVersion) {
+        log("Updating setup doc to show version: " + currentVersion);
+        Path setupDocPath = getProjectPath("docs/setup.asciidoc");
+        String contents = getContents(setupDocPath);
+        Pattern versionMentionsPattern = Pattern.compile("(?<=co\\.elastic\\.apm\\.android/)\\d+\\.\\d+\\.\\d+|(?<=co\\.elastic\\.apm:android-sdk:)\\d+\\.\\d+\\.\\d+|(?<=id\\s\"co\\.elastic\\.apm\\.android\"\\sversion\\s\")\\d+\\.\\d+\\.\\d+");
+        Matcher versionMentionMatcher = versionMentionsPattern.matcher(contents);
+
+        String setupDocWithNewVersion = versionMentionMatcher.replaceAll(currentVersion);
+        replaceFileContents(setupDocPath, setupDocWithNewVersion.getBytes(StandardCharsets.UTF_8));
+    }
+
     private byte[] resolvePlaceholders(String text, String newVersion) {
         Map<String, String> substitutions = new HashMap<>();
         substitutions.put("release_date", new SimpleDateFormat("yyyy/MM/dd", Locale.US).format(new Date()));
@@ -100,8 +112,8 @@ private byte[] resolvePlaceholders(String text, String newVersion) {
         return substitutor.replace(text).getBytes(StandardCharsets.UTF_8);
     }
 
-    private Path getChangelogPath() {
-        File changelog = new File("CHANGELOG.asciidoc");
+    private Path getProjectPath(String relativePath) {
+        File changelog = new File(relativePath);
         return changelog.toPath();
     }
 

docs/setup.asciidoc

@@ -40,19 +40,17 @@ You can skip this step if your `minSdkVersion` is 26 or higher.
 [[adding-gradle-plugin]]
 ==== Add the Elastic Agent Gradle plugin
 
-To automatically instrument <<supported-technologies,Supported Technologies>>, add the https://plugins.gradle.org/plugin/co.elastic.apm.android[Elastic APM agent plugin] to your application's `build.gradle` file as shown below:
+To automatically instrument <<supported-technologies,Supported Technologies>>, add the https://plugins.gradle.org/plugin/co.elastic.apm.android/0.15.0[Elastic APM agent plugin] to your application's `build.gradle` file as shown below:
 
 [source,groovy]
 ----
 // Android app's build.gradle file
 plugins {
     id "com.android.application"
-    id "co.elastic.apm.android" version "[latest_version]" <1>
+    id "co.elastic.apm.android" version "0.15.0"
 }
 ----
 
-<1> The Elastic plugin declaration must be added below the Android app plugin declaration (`com.android.application`) and below the Kotlin plugin declaration (if used).
-
 After adding the agent plugin, configure it.
 A minimal configuration sets the Elastic APM Server endpoint as shown below:
 
@@ -118,18 +116,16 @@ If you can't add the Elastic Agent Gradle plugin to your application as shown ab
 [[gradle-dependencies]]
 ==== Add the SDK dependency
 
-Add the https://central.sonatype.com/artifact/co.elastic.apm/android-sdk[Elastic APM agent SDK] to your application's `build.gradle` file as shown below:
+Add the Elastic APM agent SDK to your application's `build.gradle` file as shown below:
 
 [source,groovy]
 ----
 // Android app's build.gradle file
 dependencies {
-    implementation "co.elastic.apm:android-sdk:[latest_version]" <1>
+    implementation "co.elastic.apm:android-sdk:0.15.0"
 }
 ----
 
-<1> You can find the latest version https://central.sonatype.com/artifact/co.elastic.apm/android-sdk[here].
-
 [float]
 [[manual-configuration]]
 ==== Configure your app's info and connectivity parameters