ci: Add known SDK version workflow (#6032)

Co-authored-by: Evandro Myller <22429+emyller@users.noreply.github.com>

Author: khvn26

.github/workflows/api-run-makefile-target.yml

@@ -0,0 +1,57 @@
+name: API Run Makefile Target
+
+on:
+  workflow_dispatch:
+    inputs:
+      target:
+        description: The Makefile target to run (e.g. 'add-known-sdk-version')
+        required: true
+      opts:
+        description: Options to pass (e.g. '--sdk flagsmith-python-sdk --version 1.2.3')
+        required: false
+        default: ""
+      pr-title:
+        description: The title to use for the PR
+        required: true
+      pr-notes:
+        description: Additional notes to add to the PR body
+        required: false
+        default: ""
+
+permissions:
+  contents: write
+  pull-requests: write
+
+defaults:
+  run:
+    working-directory: api
+
+jobs:
+  add-sdk-version:
+    runs-on: depot-ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+          cache: "poetry"
+
+      - name: Install Dependencies
+        run: make install-packages
+
+      - name: Run `make ${{ inputs.target }} opts=${{ inputs.opts }}`
+        env:
+          opts: ${{ inputs.opts }}
+        run: make ${{ inputs.target }}
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          branch: chore/make-${{ inputs.target }}-${{ github.run_id }}
+          title: ${{ inputs.pr-title }}
+          body: |
+            Results of `make ${{ inputs.target }} opts="${{ inputs.opts }}"` ran on commit ${{ github.sha }}.
+
+            ${{ inputs.pr-notes }}

api/Makefile

@@ -152,3 +152,7 @@ integrate-private-tests:
 .PHONY: generate-docs
 generate-docs:
 	poetry run flagsmith docgen metrics > ../docs/docs/system-administration/metrics.md
+
+.PHONY: add-known-sdk-version
+add-known-sdk-version:
+	poetry run python scripts/add-known-sdk-version.py $(opts)

api/scripts/add-known-sdk-version.py

@@ -0,0 +1,56 @@
+import argparse
+import re
+from pathlib import Path
+
+MODULE_PATH = "app_analytics/constants.py"
+VERSIONS_CONSTANT_NAME = "SDK_USER_AGENT_KNOWN_VERSIONS"
+
+
+def add_version(sdk_name: str, new_version: str) -> None:
+    """Add a new version to known versions constants"""
+    contents = Path(MODULE_PATH).read_text()
+
+    # Add SDK version
+    contents = re.sub(
+        pattern=rf"""
+            ^  # Expect to have definition at module-level
+            (?P<constant_def>{VERSIONS_CONSTANT_NAME}[^=]*=\s*\{{)
+            (?P<prior_sdks>[^\}}]+)
+            (?P<sdk_def>"{sdk_name}"\s*:\s*\[)
+            (?P<sdk_versions>[^\]]*)
+            (?P<latest_version>"(?:unknown|\d[^"]+)"),?
+        """,
+        repl=(
+            r"\g<constant_def>\g<prior_sdks>\g<sdk_def>\g<sdk_versions>\g<latest_version>"
+            f',\n        "{new_version}",\n    '
+        ),
+        string=contents,
+        count=1,
+        flags=re.MULTILINE | re.VERBOSE,
+    )
+
+    Path(MODULE_PATH).write_text(contents)
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(
+        description="Add a known SDK version to an existing constants entry."
+    )
+    parser.add_argument(
+        "--sdk",
+        type=str,
+        required=True,
+        help="The SDK name, e.g. flagsmith-js-sdk",
+    )
+    parser.add_argument(
+        "--version",
+        type=str,
+        required=True,
+        help="The SDK version, e.g. 9.4.0",
+    )
+    args = parser.parse_args()
+    add_version(args.sdk, args.version)
+
+
+if __name__ == "__main__":
+    main()