[AAWF-420] Update release workflow (#2580)

* update workflow

* use version file

* use hard coded version file

* update re

* fix workflow

* fix workflow

Author: skarimo

.github/workflows/prepare_release.yml

@@ -15,23 +15,30 @@ jobs:
     name: Upload release
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v3
-        # Include all history and tags, needed for building the right version
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
-          ref: ${{ github.event.release.tag_name }}
-          fetch-depth: 0
+          fetch-depth: 1
 
       - uses: actions/setup-python@v4
         name: Install Python
         with:
           python-version: "3.11"
           cache: "pip"
 
-      - name: Install pypa/build
-        run: python -m pip install build --user
+      - name: Releasing tag ${{ github.event.release.tag_name }}
+        run: |
+          # Get tag name from event
+          tag_name="${{ github.event.release.tag_name }}"
 
-      - name: Build a binary wheel and a source tarball
-        run: python -m build --sdist --wheel --outdir dist/ .
+          if [[ ! "$tag_name" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            cd $(echo $tag_name | rev | cut -d'/' -f2- | rev)
+          fi
+
+          # Install pypa/build
+          python -m pip install build --user
+
+          # Build a binary wheel and a source tarball
+          python -m build --sdist --wheel --outdir dist/ .
 
       - name: Publish a Python distribution to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/publish.yml

@@ -4,11 +4,16 @@ permissions:
   contents: write
   pull-requests: write
 
+env:
+  GIT_AUTHOR_EMAIL: "packages@datadoghq.com"
+  GIT_AUTHOR_NAME: "ci.datadog-api-spec"
+
 on:
   pull_request:
     types: [closed]
     branches:
       - master
+      - v2
 
 jobs:
   create_release:
@@ -18,27 +23,70 @@ jobs:
     steps:
       - name: Get GitHub App token
         id: get_token
-        uses: actions/create-github-app-token@v1
+        uses: actions/create-github-app-token@c1a285145b9d317df6ced56c09f525b5c2b6f755 #v1.11.1
         with:
           app-id: ${{ secrets.PIPELINE_GITHUB_APP_ID }}
           private-key: ${{ secrets.PIPELINE_GITHUB_APP_PRIVATE_KEY }}
-      - name: Create release
-        uses: actions/github-script@v6
-        env:
-          RELEASE_BRANCH: ${{ github.head_ref }}
+
+      - name: Checkout ${{ github.event.pull_request.base.ref }}
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
-          github-token: ${{ steps.get_token.outputs.token }}
-          script: |
-            const tagName = process.env.RELEASE_BRANCH.split("/")[1];
-            await github.rest.git.createRef({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              ref: `refs/tags/${tagName}`,
-              sha: context.payload.pull_request.merge_commit_sha,
-            });
-            await github.rest.repos.createRelease({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              generate_release_notes: true,
-              tag_name: tagName,
-            });
+          token: ${{ steps.get_token.outputs.token }}
+          ref: ${{ github.event.pull_request.base.ref }}
+          fetch-depth: 0
+
+      - name: Release packages
+        env:
+          HEAD_SHA: ${{ github.event.pull_request.head.sha }}
+          BASE_SHA: ${{ github.event.pull_request.base.sha }}
+          GH_TOKEN: ${{ steps.get_token.outputs.token }}
+        shell: bash
+        run: |
+          CHANGED_VERSION_FILES=$(git diff --diff-filter=MACR --name-only $BASE_SHA...$HEAD_SHA \
+            | grep -E 'version\.py$' \
+            | xargs dirname | xargs dirname | xargs dirname \
+            | sort \
+            | uniq)
+
+          declare -A versions
+          for package in $CHANGED_VERSION_FILES; do
+            base_version=$(git show $BASE_SHA:$package/src/datadog_api_client/version.py | grep "__version__ = " | sed 's/.*"\(.*\)".*/\1/')
+            head_version=$(git show $HEAD_SHA:$package/src/datadog_api_client/version.py | grep "__version__ = " | sed 's/.*"\(.*\)".*/\1/')
+
+            if [ "$base_version" != "$head_version" ]; then
+              versions[$package]=$head_version
+            fi
+          done
+
+          for package in "${!versions[@]}"; do
+            echo "Releasing $package at version ${versions[$package]}"
+
+            # Build the tag name
+            if [[ "$package" == "." ]]; then
+              # If the package is the root, use the version as the tag name
+              tag_name="${versions[$package]}"
+            else
+              # If the package is not the root, use the package name and version as the tag name
+              tag_name="$package/${versions[$package]}"
+            fi
+
+            # Get the changelog entries since last release
+            # TODO: Implement this
+            # changelog_content=$(git diff $BASE_REF...$HEAD_REF -- $package/CHANGELOG.md | grep -A 1000 "^+##" | grep -v "^+++" | sed 's/^+//')
+
+            is_prerelease=$(echo $package | grep -q "beta" && echo true || echo false)
+            # Create the tag
+            gh api repos/{owner}/{repo}/git/refs \
+              -f ref="refs/tags/$tag_name" \
+              -f sha=$HEAD_SHA
+
+            # Create the release
+            gh api repos/{owner}/{repo}/releases --input - << EOF
+            {
+              "tag_name": "$tag_name",
+              "name": "$tag_name",
+              "body": "See $package/CHANGELOG.md for details",
+              "prerelease": $is_prerelease
+            }
+          EOF
+          done

.github/workflows/release.yml

@@ -1,4 +1,3 @@
-src/datadog_api_client/version.py
 site
 docs/.sphinx
 

.gitignore

@@ -4,33 +4,14 @@
 # Copyright 2019 Datadog, Inc.
 
 import os
+import re
 
 from setuptools import setup
 
-version_template = """\
-# Unless explicitly stated otherwise all files in this repository are licensed
-# under the 3-clause BSD style license (see LICENSE).
-# This product includes software developed at Datadog (https://www.datadoghq.com/).
-# Copyright 2020-Present Datadog, Inc.
-
-__version__ = "{version}"
-"""
-
-# Allows the fetching of tags even from shallow clones
-# https://github.com/pypa/setuptools_scm/pull/118#issuecomment-255381535
-def parse_fetch_on_shallow(*args, **kwargs):
-    from setuptools_scm.git import parse, fetch_on_shallow
-
-    kwargs["pre_parse"] = fetch_on_shallow
-
-    return parse(*args, **kwargs)
+ROOT = os.path.dirname(__file__)
+VERSION_RE = re.compile(r'''__version__ = ['"]([0-9]+\.[0-9]+\.[0-9]+.*)['"]''')
 
 
 setup(
-    use_scm_version={
-        "local_scheme": "dirty-tag",
-        "write_to": os.path.join("src", "datadog_api_client", "version.py"),
-        "write_to_template": version_template,
-        "parse": parse_fetch_on_shallow,
-    }
+    version=VERSION_RE.search(open(os.path.join(ROOT, "src", "datadog_api_client", "version.py")).read()).group(1),
 )

RELEASING.md

@@ -0,0 +1,6 @@
+# Unless explicitly stated otherwise all files in this repository are licensed
+# under the 3-clause BSD style license (see LICENSE).
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2020-Present Datadog, Inc.
+
+__version__ = "2.34.0"