[CI] Enhance backport_branch.sh to handle the case when package name and path are not identical (#14814)

Author: mykola-elastic

.buildkite/pipeline.backport.yml

@@ -31,10 +31,14 @@ steps:
  key: "BASE_COMMIT"
  required: true
  default: ""
- - text: "Enter package name"
+ - text: "Enter package name (as defined in manifest.yml)"
  key: "PACKAGE_NAME"
  required: true
  default: ""
+ - text: "Enter name of the folder for the package (in most cases coincides with PACKAGE_NAME)"
+ key: "PACKAGE_FOLDER_NAME"
+ required: true
+ default: ""
  - text: "Enter package version (examples: 1.5.7, 1.0.0-beta1)"
  key: "PACKAGE_VERSION"
  required: true

.buildkite/scripts/backport_branch.sh

@@ -16,11 +16,12 @@ trap cleanup_gh EXIT
 DRY_RUN="$(buildkite-agent meta-data get DRY_RUN --default ${DRY_RUN:-"true"})"
 BASE_COMMIT="$(buildkite-agent meta-data get BASE_COMMIT --default ${BASE_COMMIT:-""})"
 PACKAGE_NAME="$(buildkite-agent meta-data get PACKAGE_NAME --default ${PACKAGE_NAME:-""})"
+PACKAGE_FOLDER_NAME="$(buildkite-agent meta-data get PACKAGE_FOLDER_NAME --default ${PACKAGE_FOLDER_NAME:-""})"
 PACKAGE_VERSION="$(buildkite-agent meta-data get PACKAGE_VERSION --default ${PACKAGE_VERSION:-""})"
 REMOVE_OTHER_PACKAGES="$(buildkite-agent meta-data get REMOVE_OTHER_PACKAGES --default ${REMOVE_OTHER_PACKAGES:-"false"})"
 
-if [[ -z "$PACKAGE_NAME" ]] || [[ -z "$PACKAGE_VERSION" ]]; then
- buildkite-agent annotate "The variables **PACKAGE_NAME** or **PACKAGE_VERSION** aren't defined, please try again" --style "warning"
+if [[ -z "$PACKAGE_NAME" ]] || [[ -z "$PACKAGE_FOLDER_NAME" ]] || [[ -z "$PACKAGE_VERSION" ]]; then
+ buildkite-agent annotate "The variables **PACKAGE_NAME**, **PACKAGE_FOLDER_NAME** or **PACKAGE_VERSION** aren't defined, please try again" --style "warning"
  exit 1
 fi
 
@@ -29,6 +30,7 @@ PARAMETERS=(
  "**DRY_RUN**=$DRY_RUN"
  "**BASE_COMMIT**=$BASE_COMMIT"
  "**PACKAGE_NAME**=$PACKAGE_NAME"
+ "**PACKAGE_FOLDER_NAME**=$PACKAGE_FOLDER_NAME"
  "**PACKAGE_VERSION**=$PACKAGE_VERSION"
  "**REMOVE_OTHER_PACKAGES**=$REMOVE_OTHER_PACKAGES"
 )
@@ -98,7 +100,7 @@ removeOtherPackages() {
  local sourceFolder=$1
  local currentPackage=""
  for dir in "$sourceFolder"/*; do
- if [[ -d "$dir" ]] && [[ "$(basename "$dir")" != "$PACKAGE_NAME" ]]; then
+ if [[ -d "$dir" ]] && [[ "$(basename "$dir")" != "$PACKAGE_FOLDER_NAME" ]]; then
  echo "Removing directory: $dir"
  rm -rf "$dir"
 
@@ -212,7 +214,7 @@ updateBackportBranchContents() {
  if [ "$DRY_RUN" == "true" ];then
  echo "DRY_RUN mode, nothing will be pushed."
  # Show just the relevant files diff (go.mod, go.sum, .buildkite, dev, .go-version, .github/CODEOWNERS and package to be backported)
- git --no-pager diff $SOURCE_BRANCH...$BACKPORT_BRANCH_NAME .buildkite/ dev/ go.sum go.mod .go-version .github/CODEOWNERS "packages/${PACKAGE_NAME}"
+ git --no-pager diff $SOURCE_BRANCH...$BACKPORT_BRANCH_NAME .buildkite/ dev/ go.sum go.mod .go-version .github/CODEOWNERS "packages/${PACKAGE_FOLDER_NAME}"
  else
  echo "Pushing..."
  git push origin $BACKPORT_BRANCH_NAME
@@ -252,15 +254,15 @@ if branchExist "$BACKPORT_BRANCH_NAME"; then
 fi
 
 # backport branch does not exist, running checks and create branch
-version="$(git show "${BASE_COMMIT}":"packages/${PACKAGE_NAME}/manifest.yml" | yq -r .version)"
+version="$(git show "${BASE_COMMIT}":"packages/${PACKAGE_FOLDER_NAME}/manifest.yml" | yq -r .version)"
 echo "Check if version from ${BASE_COMMIT} (${version}) matches with version from input step ${PACKAGE_VERSION}"
 if [[ "${version}" != "${PACKAGE_VERSION}" ]]; then
- buildkite-agent annotate "Unexpected version found in packages/${PACKAGE_NAME}/manifest.yml" --style "error"
+ buildkite-agent annotate "Unexpected version found in packages/${PACKAGE_FOLDER_NAME}/manifest.yml" --style "error"
  exit 1
 fi
 
 echo "Check that this changeset is the one creating the version $PACKAGE_NAME"
-if ! git show -p ${BASE_COMMIT} packages/${PACKAGE_NAME}/manifest.yml | grep -E "^\+version: \"{0,1}${PACKAGE_VERSION}" ; then
+if ! git show -p ${BASE_COMMIT} packages/${PACKAGE_FOLDER_NAME}/manifest.yml | grep -E "^\+version: \"{0,1}${PACKAGE_VERSION}" ; then
  buildkite-agent annotate "This changeset does not creates the version ${PACKAGE_VERSION}" --style "error"
  exit 1
 fi

docs/extend/developer-workflow-support-old-package.md

@@ -73,7 +73,8 @@ Follow these detailed steps to release a fix for a given package version:
  If DRY_RUN is defined as "false", in addition to written above it will create a commit and push the local branch to the upstream repository [https://github.com/elastic/integrations.git](https://github.com/elastic/integrations.git). In this case, the name of the branch will be `+backport-${PACKAGE_NAME}-${TRIMMED_PACKAGE_VERSION}+`, for example, `backport-aws-1.19`.
 
  * **BASE_COMMIT** (default: "") - enter the commit from the previous step (8cb321075afb9b77ea965e1373a03a603d9c9796)
- * **PACKAGE_NAME** (default: "") - enter the package name, for example aws
+ * **PACKAGE_NAME** (default: "") - enter the package name, as defined in manifest.yml, for example aws
+ * **PACKAGE_FOLDER_NAME** (default: "") - enter the package folder name, in most cases coincides with package name, for example "sql_input" (but package name is "sql")
  * **PACKAGE_VERSION** (default: "") - enter the package version, for example: 1.19.7, 1.0.0-beta1
  * **REMOVE_OTHER_PACKAGES** (default: "false") If **REMOVE_OTHER_PACKAGES** is defined as "true" all packages from the **packages** folder, except the defined package, will be removed from the created branch.