Reduce boilerplate sprawl for independent release instrumentations

.github/workflows/generate_workflows.py

@@ -4,6 +4,7 @@
     generate_contrib_workflow,
     generate_lint_workflow,
     generate_misc_workflow,
+    generate_release_workflows,
     generate_test_workflow,
 )
 
@@ -14,3 +15,4 @@
 generate_lint_workflow(tox_ini_path, workflows_directory_path)
 generate_misc_workflow(tox_ini_path, workflows_directory_path)
 generate_contrib_workflow(workflows_directory_path)
+generate_release_workflows(workflows_directory_path)

.github/workflows/generate_workflows_lib/src/generate_workflows_lib/__init__.py

@@ -2,6 +2,9 @@
 from pathlib import Path
 from re import compile as re_compile
 
+from discover_genai_packages import (
+    get_independent_release_packages,
+)
 from jinja2 import Environment, FileSystemLoader
 from tox.config.cli.parse import get_options
 from tox.config.sets import CoreConfigSet
@@ -235,3 +238,36 @@ def generate_misc_workflow(
         "misc",
         workflow_directory_path,
     )
+
+
+def generate_release_workflows(
+    workflow_directory_path: Path,
+) -> None:
+    genai_packages = get_independent_release_packages()
+
+    release_options = [
+        "opentelemetry-opamp-client",
+        "opentelemetry-propagator-aws-xray",
+        "opentelemetry-resource-detector-azure",
+        "opentelemetry-sdk-extension-aws",
+        "opentelemetry-util-genai",
+    ] + genai_packages
+
+    env = Environment(
+        loader=FileSystemLoader(Path(__file__).parent),
+        trim_blocks=True,
+        lstrip_blocks=True,
+    )
+
+    for template_name in [
+        "package-prepare-release",
+        "package-prepare-patch-release",
+        "package-release",
+    ]:
+        with open(
+            workflow_directory_path.joinpath(f"{template_name}.yml"), "w"
+        ) as workflow_file:
+            text = env.get_template(f"{template_name}.yml.j2").render(
+                release_options=release_options
+            )
+            workflow_file.write(text)

.github/workflows/generate_workflows_lib/src/generate_workflows_lib/package-prepare-patch-release.yml.j2

@@ -0,0 +1,132 @@
+# Do not edit this file.
+# This file is generated automatically by executing tox -e generate-workflows
+name: "[Package] Prepare patch release"
+on:
+  workflow_dispatch:
+    inputs:
+      package:
+        type: choice
+        options:
+{% for option in release_options %}
+        - {{ option }}
+{% endfor %}
+{% raw %}        description: 'Package to be released'
+        required: true
+permissions:
+  contents: read
+run-name: "[Package][${{ inputs.package }}] Prepare patch release"
+
+jobs:
+  prepare-patch-release:
+    permissions:
+      contents: write # required for pushing branches
+      pull-requests: write # required for creating pull requests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Verify prerequisites
+        run: |
+          if [[ $GITHUB_REF_NAME != package-release/${{ inputs.package }}/v* ]]; then
+            echo this workflow should only be run against package-release/${{ inputs.package }}* branches, but is running on $GITHUB_REF_NAME
+            exit 1
+          fi
+
+          path=./$(./scripts/eachdist.py find-package --package ${{ inputs.package }})
+          changelog=$path/CHANGELOG.md
+
+          if [ ! -f $changelog ]; then
+            echo "missing $changelog file"
+            exit 1
+          fi
+
+          if ! grep --quiet "^## Unreleased$" CHANGELOG.md; then
+            echo the $changelog is missing an \"Unreleased\" section
+            exit 1
+          fi
+
+          version=$(./scripts/eachdist.py version --package ${{ inputs.package }})
+
+          version_file=$(find $path -type f -path "**/version.py")
+          file_count=$(echo "$version_file" | wc -l)
+
+          if [ "$file_count" -ne 1 ]; then
+            echo "Error: expected one version file, found $file_count"
+            echo "$version_file"
+            exit 1
+          fi
+
+          if [[ $version =~ ^([0-9]+)\.([0-9]+)\.([0-9]+) ]]; then
+            # 1.2.3 or 1.2.3rc1
+            major="${BASH_REMATCH[1]}"
+            minor="${BASH_REMATCH[2]}"
+            patch="${BASH_REMATCH[3]}"
+            next_version="$major.$minor.$((patch + 1))"
+            release_branch_name="package-release/${{ inputs.package }}/v$major.$minor.x"
+          elif [[ $version =~ ^([0-9]+)\.([0-9]+)b([0-9]+)$ ]]; then
+            # 0.1b1
+            major="${BASH_REMATCH[1]}"
+            minor="${BASH_REMATCH[2]}"
+            patch="${BASH_REMATCH[3]}"
+            next_version="$major.${minor}b$((patch + 1))"
+            release_branch_name="package-release/${{ inputs.package }}/v$major.${minor}bx"
+          else
+            echo "unexpected version: '$version'"
+            exit 1
+          fi
+
+          if [[ $GITHUB_REF_NAME != $release_branch_name ]]; then
+            echo this workflow should only be run against $release_branch_name branch, but is running on $GITHUB_REF_NAME
+            exit 1
+          fi
+
+          echo "PACKAGE_NAME=${{ inputs.package }}" >> $GITHUB_ENV
+          echo "VERSION=$version" >> $GITHUB_ENV
+          echo "NEXT_VERSION=$next_version" >> $GITHUB_ENV
+          echo "CHANGELOG=$changelog" >> $GITHUB_ENV
+          echo "VERSION_FILE=$version_file" >> $GITHUB_ENV
+
+      - name: Update version
+        run: |
+          # replace the version in the version file (1.2.3 -> 1.2.4)
+          sed -i -E "s/__version__\s*=\s*\"${VERSION}\"/__version__ = \"${NEXT_VERSION}\"/g" $VERSION_FILE
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+      - name: Install tox
+        run: pip install tox
+      - name: run tox
+        run: tox -e generate
+
+      - name: Update the change log with the approximate release date
+        run: |
+          # the actual release date on main will be updated at the end of the release workflow
+          date=$(date "+%Y-%m-%d")
+          sed -Ei "s/^## Unreleased$/## Unreleased\n\n## Version ${NEXT_VERSION} ($date)/" ${CHANGELOG}
+
+      - name: Use CLA approved github bot
+        run: .github/scripts/use-cla-approved-github-bot.sh
+
+      - uses: actions/create-github-app-token@df432ceedc7162793a195dd1713ff69aefc7379e # v2.0.6
+        id: otelbot-token
+        with:
+          app-id: ${{ vars.OTELBOT_APP_ID }}
+          private-key: ${{ secrets.OTELBOT_PRIVATE_KEY }}
+
+      - name: Create pull request
+        env:
+          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
+          GITHUB_TOKEN: ${{ steps.otelbot-token.outputs.token }}
+        run: |
+          message="Prepare patch release for ${PACKAGE_NAME} v${NEXT_VERSION}"
+          branch="otelbot/patch-${PACKAGE_NAME}-version-to-v${NEXT_VERSION}"
+
+          git commit -a -m "$message"
+          git push origin HEAD:$branch
+          gh pr create --title "[$GITHUB_REF_NAME] $message" \
+                       --body "$message." \
+                       --head $branch \
+                       --base $GITHUB_REF_NAME
+{% endraw %}