GHA: add push pr job for update rules (#2115)

* add push pr job

Signed-off-by: habibayassin <[email protected]>

Author: habibayassin

.github/workflows/github-actions-cron-sync-fork-from-upstream.yml

@@ -10,8 +10,6 @@ on:
         description: Use GitHub --force push.
         default:
 
-  repository_dispatch:
-
 
 jobs:
   Sync-Branch-From-Upstream:

.github/workflows/github-actions-update-rules.yml

@@ -15,6 +15,7 @@ jobs:
         with:
           submodules: recursive
           fetch-depth: 0
+          ref: ${{ github.event.client_payload.branch }}
       - uses: actions/setup-python@v4
         with:
           python-version: "3.10"
@@ -29,9 +30,9 @@ jobs:
           echo ${{ github.event_name }}
           echo ${{ github.event.client_payload.type }}
           if [[ "${{ github.event_name }}" == "repository_dispatch" && "${{ github.event.client_payload.type }}" == "overwrite" ]]; then
-            python flow/util/updateRules.py --keyFile "${CREDS_FILE}" --apiURL ${API_BASE_URL} --overwrite
+            python flow/util/updateRules.py --keyFile "${CREDS_FILE}" --apiURL ${API_BASE_URL} --commitSHA ${{ github.event.client_payload.commitsha }} --overwrite
           else 
-            python flow/util/updateRules.py --keyFile "${CREDS_FILE}" --apiURL ${API_BASE_URL}
+            python flow/util/updateRules.py --keyFile "${CREDS_FILE}" --apiURL ${API_BASE_URL} --commitSHA ${{ github.event.client_payload.commitsha }}
           fi
       - name: Push updated rules
         id: remote-update
@@ -44,8 +45,13 @@ jobs:
             echo "has_update=false" >> "$GITHUB_OUTPUT"
           fi
           git add .
-          git commit -m "flow: update rules based on new golden reference"
-      - if: "steps.remote-update.outputs.has_update == 'true'"
+          git commit --signoff -m "flow: update rules based on new golden reference"
+      - if: "github.event.client_payload.branch != 'master'"
+        name: update rules pr
+        id: remote-update-pr
+        run: |
+          git push origin ${{ github.event.client_payload.branch }}
+      - if: "steps.remote-update.outputs.has_update == 'true' && github.event.client_payload.branch == 'master'"
         name: Create Draft PR
         uses: peter-evans/create-pull-request@v5
         with:

flow/util/genRuleFile.py

@@ -27,6 +27,23 @@ def get_golden(platform, design, api_base_url):
         print(f"An error occurred: {str(e)}")
         return None, f"An error occurred: {str(e)}"
 
+def get_metrics(commitSHA, platform, design, api_base_url):
+    try:
+        response = requests.get(api_base_url+f"/commit?commitSHA={commitSHA}&platform={platform}&design={design}&variant=base")
+
+        # Check if the request was successful (status code 200)
+        if response.status_code == 200 and "error" not in response.json():
+            # Parse the JSON response
+            data = response.json()
+
+            return data, None
+        else:
+            print("API request failed")
+            return None, "API request failed"
+    except Exception as e:
+        print(f"An error occurred: {str(e)}")
+        return None, f"An error occurred: {str(e)}"
+
 def update_rules(designDir, variant, golden_metrics, overwrite):
     if overwrite:
         gen_rule_file(designDir, # design directory
@@ -286,7 +303,7 @@ def gen_rule_file(design_dir, update, tighten, failing, variant, golden_metrics=
 
             if update and old_rule['value'] != rule_value:
                 UPDATE = True
-                change_str += format.format_str.format(field, old_rule['value'],
+                change_str += format_str.format(field, old_rule['value'],
                                                        rule_value, 'Updating')
 
             if not UPDATE:
@@ -340,4 +357,4 @@ def gen_rule_file(design_dir, update, tighten, failing, variant, golden_metrics=
         parser.print_help()
         sys.exit(1)
 
-    gen_rule_file(args.dir, args.update, args.tighten, args.failing, args.variant)
+    gen_rule_file(args.dir, args.update, args.tighten, args.failing, args.variant)

flow/util/updateRules.py

@@ -9,6 +9,7 @@
 import requests
 from genRuleFile import get_golden
 from genRuleFile import update_rules
+from genRuleFile import get_metrics
 
 # make sure the working dir is flow/
 os.chdir(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
@@ -19,6 +20,7 @@
 parser.add_argument('--keyFile', type=str, help='Service account credentials key file')
 parser.add_argument('--overwrite', action='store_true', default=False, help='Overwrite the golden metrics')
 parser.add_argument('--apiURL', type=str, default="http://localhost:80", help='Set API Base URL to get golden metrics')
+parser.add_argument('--commitSHA', type=str, default="", help='commit for the metrics used to update the rules')
 
 # Parse the arguments
 args = parser.parse_args()
@@ -44,15 +46,16 @@
     test = '{} {}'.format(platform, design)
     dataFile = os.path.join(designsDir, runFilename)
     if os.path.exists(dataFile) and (platform != 'sky130hd_fakestack' or platform != 'src'):
-        golden_metrics, error_golden_metrics = get_golden(platform, # platform
-                                                        design, # design
-                                                        api_base_url # backend url
-                                                        )
-        if error_golden_metrics:
+        metrics, error_metrics = get_metrics(args.commitSHA, # commit
+                            platform, # platform
+                            design, # design
+                            api_base_url # backend url
+                            )
+        if error_metrics:
             print("failed to update rule for", platform, design)
             continue
         update_rules(designsDir, # design directory
                     "base", # variant
-                    golden_metrics, # metrics needed for update, default is {} in case of file
+                    metrics, # metrics needed for update, default is {} in case of file
                     args.overwrite # overwrite flag, default is false
-                    )
+                    )