Patch20250327: change workflow to push back to feature branch during PR (#228)

* use github actions as commit user

* fixup cli version

* change workflow to push back to feature branch during PR

* test

* test on behavior

* test on behavior

* Updated docs/compatible_version.ndjson with PR #227

* test on behavior

* Updated docs/compatible_version.ndjson with PR #227

* test on behavior

* force to update version

* Updated docs/compatible_version.ndjson with PR #228

* add step to check if we already update the PR

* Updated docs/compatible_version.ndjson with PR #228

* skip the update

---------

Co-authored-by: GitHub Actions <[email protected]>

Author: colorzzr

Diff for: .github/workflows/update_compatible_version.yml

@@ -1,27 +1,43 @@
 name: Update Compatible Versions
 
 on:
-  workflow_run:
-    workflows: [ "Build and Publish" ]
+  pull_request:
+    types: [opened, synchronize, reopened] # dont trigger on closed
     branches:
+      - main
       - develop
-    types:
-      - completed
-
-  pull_request:
-    types:
-      - closed    # Ensures it runs only on PR closure (merge)
 
 jobs:
   update-compatible-versions:
-    if: github.event.pull_request.merged == true  # Runs only if PR is merged
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Check if CLI version was already updated
+        id: check_version
+        run: |
+          # Extract current version from pyproject.toml
+          CURRENT_VERSION=$(grep '^version =' pyproject.toml | sed -E 's/version = "(.*)"/\1/')
+          echo "Current version: $CURRENT_VERSION"
+
+          # Read the last entry from NDJSON file (if it exists)
+          LAST_VERSION=$(tail -n 1 docs/compatible_version.ndjson 2>/dev/null | jq -r '."Cli Version"')
+
+          echo "Last updated version: $LAST_VERSION"
+          echo "current=$CURRENT_VERSION" >> "$GITHUB_OUTPUT"
+          echo "last=$LAST_VERSION" >> "$GITHUB_OUTPUT"
+
+      - name: Exit if already updated
+        if: ${{ steps.check_version.outputs.current == steps.check_version.outputs.last }}
+        run: |
+          echo "This version was already recorded. Skipping update."
 
       - name: Extract Versions from PR
+        if: ${{ steps.check_version.outputs.current != steps.check_version.outputs.last }}
         id: extract_versions
         run: |
           PR_BODY="${{ github.event.pull_request.body }}"
@@ -50,6 +66,7 @@ jobs:
           echo "$NEW_ENTRY" >> docs/compatible_version.ndjson
 
       - name: Embed Compatible Versions into README
+        if: ${{ steps.check_version.outputs.current != steps.check_version.outputs.last }}
         run: |
           # Define markers
           START_MARKER="<!-- COMPATIBLE_VERSIONS_START -->"
@@ -77,10 +94,15 @@ jobs:
           mv README_UPDATED.md README.md
 
       - name: Commit and Push Changes
+        if: ${{ steps.check_version.outputs.current != steps.check_version.outputs.last }}
         run: |
           git config user.name "GitHub Actions"
           git config user.email "[email protected]"
+          git pull origin ${{ github.head_ref }}
           git add docs/compatible_version.ndjson README.md
           git commit -m "Updated docs/compatible_version.ndjson with PR #${{ github.event.pull_request.number }}"
-          git push
-        continue-on-error: true  # Avoid breaking workflow if no changes detected
+
+      - name: Push change to feature branch
+        if: ${{ steps.check_version.outputs.current != steps.check_version.outputs.last }}
+        run: |
+          git push origin HEAD:${{ github.head_ref }} -f

Diff for: README.md

@@ -44,7 +44,15 @@ Command line tool that allows the user to execute data operations on the platfor
 
 ## Compatible versions
 <!-- COMPATIBLE_VERSIONS_START -->
-
+| Cli Version | Pilot Release Version | Compatible Version |
+|------------|----------------------|---------------------|
+| 3.15.0 | 2.14.2 | 2.14.2 |
+| 3.15.1 | 2.14.2 | 2.14.2 |
+| 3.15.2 | 2.15 | 2.15 |
+| 3.16.0 | 2.15 | 2.15 |
+| 3.17.0 | 2.15 | 2.15 |
+| 3.17.1 | 2.15 | 2.15 |
+| 3.17.1 | 2.15 | 2.15 |
 <!-- COMPATIBLE_VERSIONS_END -->
 
 ## Build Instructions

Diff for: docs/compatible_version.ndjson

@@ -3,3 +3,4 @@
 {"Cli Version": "3.15.2", "Pilot Release Version": "2.15", "Compatible Version": "2.15"}
 {"Cli Version": "3.16.0", "Pilot Release Version": "2.15", "Compatible Version": "2.15"}
 {"Cli Version": "3.17.0", "Pilot Release Version": "2.15", "Compatible Version": "2.15"}
+{"Cli Version": "3.17.1", "Pilot Release Version": "2.15", "Compatible Version": "2.15"}