Add support for VERSION_QUALIFIER DRA (#2920)

* Add support for VERSION_QUALIFIER

* add qualifier to binary version output

* add qualifier to binary version output

* shfmt

* consistency on  VERSION_QUALIFIER expansio

* set VERSION_QUALIFIER for main branch to alpha1 (temporary)

Author: moukoublen

.buildkite/pipeline.yml

@@ -5,6 +5,13 @@ agents:
   image: "family/platform-ingest-beats-ubuntu-2204"
 
 steps:
+  # TODO: this will be removed/changed for 9.0 branch
+  - label: ":writing_hand: Conditionally set VERSION_QUALIFIER for main branch"
+    if: build.branch == "main"
+    env:
+      VERSION_QUALIFIER: "alpha1"
+    command: "echo 'Setting VERSION_QUALIFIER for branch main'"
+
   - label: ":package: Package Cloudbeat - Snapshot"
     if: build.branch == 'main' || build.branch =~ /^[0-9]+\.[0-9x]+\$/ || build.env("RUN_RELEASE") == "true"
     env:
@@ -20,16 +27,19 @@ steps:
     env:
       WORKFLOW: "snapshot"
 
+    # Allow building staging from main when VERSION_QUALIFIER is set (allow prerelease testing)
+    # TODO remove || build.env('VERSION_QUALIFIER') != null
   - label: ":package: Package Cloudbeat - Staging"
-    if: build.branch =~ /^[0-9]+\.[0-9]+\$/ || build.env("RUN_RELEASE") == "true"
+    if: build.branch =~ /^[0-9]+\.[0-9]+\$/ || build.env("RUN_RELEASE") == "true" || build.env('VERSION_QUALIFIER') != null
     env:
       WORKFLOW: "staging"
     key: "package-staging"
     command: "./.buildkite/scripts/package.sh"
     artifact_paths: "build/distributions/*"
 
+  # TODO remove || build.env('VERSION_QUALIFIER') != null
   - label: ":rocket: Publishing Staging DRA artifacts"
-    if: build.branch =~ /^[0-9]+\.[0-9]+\$/ || build.env("RUN_RELEASE") == "true"
+    if: build.branch =~ /^[0-9]+\.[0-9]+\$/ || build.env("RUN_RELEASE") == "true" || build.env('VERSION_QUALIFIER') != null
     depends_on: "package-staging"
     command: "./.buildkite/scripts/publish.sh"
     env:

.buildkite/scripts/package.sh

@@ -8,6 +8,7 @@ source ./bin/activate-hermit
 CLOUDBEAT_VERSION=$(grep defaultBeatVersion version/version.go | cut -d'=' -f2 | tr -d '" ')
 PYTHON_BIN=./build/ve/$(go env GOOS)/bin
 PYTHON=$PYTHON_BIN/python
+VERSION_QUALIFIER="${VERSION_QUALIFIER:-""}"
 
 if [ "$WORKFLOW" = "snapshot" ]; then
     export SNAPSHOT="true"
@@ -21,6 +22,9 @@ mage package
 
 CSV_FILE="build/dependencies-${CLOUDBEAT_VERSION}"
 [ -n "${SNAPSHOT+x}" ] && CSV_FILE+="-SNAPSHOT"
+if [[ -n "$VERSION_QUALIFIER" ]]; then
+    CSV_FILE+="-${VERSION_QUALIFIER}"
+fi
 
 echo "Generating $CSV_FILE.csv"
 $PYTHON ./.buildkite/scripts/generate_notice.py --csv "$CSV_FILE.csv"

.buildkite/scripts/publish.sh

@@ -13,6 +13,7 @@ elif [ -n "$(git ls-remote --heads origin $MAJOR.x)" ]; then
 else
     BRANCH=main
 fi
+VERSION_QUALIFIER="${VERSION_QUALIFIER:-""}"
 
 # Download artifacts from other stages
 echo "Downloading artifacts..."
@@ -38,4 +39,5 @@ docker run --rm \
     --commit "${BUILDKITE_COMMIT}" \
     --workflow "${WORKFLOW}" \
     --version "${VERSION}" \
-    --artifact-set main
+    --artifact-set main \
+    --qualifier "${VERSION_QUALIFIER}"

magefile.go

@@ -49,8 +49,9 @@ import (
 )
 
 const (
-	snapshotEnv   = "SNAPSHOT"
-	agentDropPath = "AGENT_DROP_PATH"
+	snapshotEnv         = "SNAPSHOT"
+	agentDropPath       = "AGENT_DROP_PATH"
+	cloudbeatModulePath = "github.com/elastic/cloudbeat"
 )
 
 func init() {
@@ -80,6 +81,9 @@ func Build() error {
 
 	args := devtools.DefaultBuildArgs()
 	args.CGO = false
+	if versionQualifier, versionQualified := os.LookupEnv("VERSION_QUALIFIER"); versionQualified {
+		args.Vars[cloudbeatModulePath+"/version.qualifier"] = versionQualifier
+	}
 	return devtools.Build(args)
 }
 
@@ -95,6 +99,9 @@ func Clean() error {
 func GolangCrossBuild() error {
 	args := devtools.DefaultGolangCrossBuildArgs()
 	args.CGO = false
+	if versionQualifier, versionQualified := os.LookupEnv("VERSION_QUALIFIER"); versionQualified {
+		args.Vars[cloudbeatModulePath+"/version.qualifier"] = versionQualifier
+	}
 	return devtools.GolangCrossBuild(args)
 }
 

version/settings.go

@@ -52,6 +52,9 @@ func cloudbeatCommitTime() string {
 
 // CloudbeatSemanticVersion returns the current cloudbeat version.
 func CloudbeatSemanticVersion() string {
+	if qualifier != "" {
+		return defaultBeatVersion + "-" + qualifier
+	}
 	return defaultBeatVersion
 }
 

version/version.go

@@ -20,6 +20,8 @@ package version
 // name matches github.com/elastic/beats/v7/dev-tools/mage/settings.go parseBeatVersion
 const defaultBeatVersion = "9.0.0"
 
+var qualifier = ""
+
 // Version represents version information for a package
 type Version struct {
 	Version    string `mapstructure:"version,omitempty"`     // Version is the semantic version of the package