Automate benchmarking - for every release (#828)

## Summary
<!--- This is a required section; please describe the main purpose of
this proposed code change. --->
This pr adds code for running benchmarks for every release.
<!---
## Details
This is an optional section; is there anything specific that reviewers
should be aware of?
--->

## Testing Done
<!--- This is a required section; please describe how this change was
tested. --->

<!-- 
Replace BLANK with your device type. For example, A100-80G-PCIe

Complete the following tasks before sending your PR, and replace `[ ]`
with
`[x]` to indicate you have done them. 
-->

- Hardware Type: <BLANK>
- [ ] run `make test` to ensure correctness
- [ ] run `make checkstyle` to ensure code style
- [ ] run `make test-convergence` to ensure convergence

---------

Co-authored-by: Manan Shah <[email protected]>
Co-authored-by: Vaibhav Jindal <[email protected]>

Author: 3 people

.github/workflows/benchmark.yml

@@ -1,6 +1,8 @@
 name: Benchmarks
 
 on:
+  release:
+    types: [published]
   schedule:
     # Runs at 00:00 UTC every Friday
     - cron: '0 0 * * 5'
@@ -69,10 +71,8 @@ jobs:
 
           # Save benchmark folder from main
           cp -r benchmark /tmp/benchmark_main
-
           # Checkout back to target commit
           git checkout $ORIG_COMMIT
-
           # Replace old benchmark with one from main
           rm -rf benchmark
           cp -r /tmp/benchmark_main benchmark
@@ -124,8 +124,17 @@ jobs:
 
       # Step 6: Copy benchmark CSV to gh-pages directory
       - name: Copy generated benchmark to gh-pages
+        id: copy_benchmark
         run: |
-          COMMIT_DIR="gh-pages/${OUTPUT_DIR}/${{ steps.choose_commit.outputs.hash }}"
+          if [[ "${{ github.event_name }}" == "release" ]]; then
+            echo "Release event detected"
+            path=${{steps.choose_commit.outputs.hash}}-${{ github.event.release.tag_name }}
+          else
+            echo "Not a release event"
+            path=${{steps.choose_commit.outputs.hash}}
+          fi
+          COMMIT_DIR="gh-pages/${OUTPUT_DIR}/${path}"
+
           mkdir -p "$COMMIT_DIR"
 
           if [ -f "$COMMIT_DIR/${OUTPUT_FILENAME}" ]; then
@@ -144,7 +153,8 @@ jobs:
           mkdir -p ${OUTPUT_DIR}
           touch ${OUTPUT_DIR}/commits.txt
 
-          echo "${{ steps.choose_commit.outputs.hash }}" >> ${OUTPUT_DIR}/commits.txt
+          echo "${{ steps.copy_benchmark.outputs.path }}" >> ${OUTPUT_DIR}/commits.txt
+
           echo "Added commit hash to commits.txt"
       # Step 7: Commit and push
       - name: Commit and push to gh-pages
@@ -153,6 +163,5 @@ jobs:
           git config user.name github-actions[bot]
           git config user.email 41898282+github-actions[bot]@users.noreply.github.com
           git add .
-          git commit -m "Add benchmark for commit ${{ steps.choose_commit.outputs.hash }}" || echo "No changes to commit"
+          git commit -m "Add benchmark for commit ${{ steps.copy_benchmark.outputs.path }}" || echo "No changes to commit"
           git push origin gh-pages
-