switch to tag for pull requests.

Author: korenyoni

.github/workflows/test-negative.yml

@@ -22,7 +22,7 @@ jobs:
           release_name="${PREFIX}$(git rev-parse --short HEAD)"
           gh release create ${release_name} --prerelease --target ${{ github.sha }} --notes "Created by ${{ github.workflow }} (will be automatically deleted)."
           echo "name=${release_name}" > $GITHUB_OUTPUT
-          echo "id=$(gh release view ${release_name} --json id -q '.id')" >> $GITHUB_OUTPUT
+          echo "tag=$(gh release view ${release_name} --json tagName -q '.tagName')" >> $GITHUB_OUTPUT
         env:
           # Below is the main difference between this workflow's positive counterpart.
           # The action will not pick up a comment because the provided 'include_regex' will not be able to match it.
@@ -31,7 +31,7 @@ jobs:
 
     outputs:
       name: ${{ steps.create-release.outputs.name }}
-      id: ${{ steps.create-release.outputs.id }}
+      tag: ${{ steps.create-release.outputs.tag }}
 
   assert:
     runs-on: ubuntu-latest
@@ -42,7 +42,7 @@ jobs:
 
       - uses: ./
         with:
-          release_id: ${{ needs.create-release.outputs.id}}
+          tag: ${{ needs.create-release.outputs.tag }}
           include_regex: "/v0\\.0\\.0-test\\.include\\.*./g" # Should not find a comment
 
       - name: Find Comment (should fail)

.github/workflows/test-positive.yml

@@ -22,7 +22,7 @@ jobs:
           release_name="${PREFIX}$(git rev-parse --short HEAD)"
           gh release create ${release_name} --prerelease --target ${{ github.sha }} --notes "Created by ${{ github.workflow }} (will be automatically deleted)."
           echo "name=${release_name}" > $GITHUB_OUTPUT
-          echo "id=$(gh release view ${release_name} --json id -q '.id')" >> $GITHUB_OUTPUT
+          echo "tag=$(gh release view ${release_name} --json tagName -q '.tagName')" >> $GITHUB_OUTPUT
         env:
           # Below is the main difference between this workflow's negative counterpart.
           # The action _will_ pick up a comment because the provided 'include_regex' will be able to match it.
@@ -31,7 +31,7 @@ jobs:
 
     outputs:
       name: ${{ steps.create-release.outputs.name }}
-      id: ${{ steps.create-release.outputs.id }}
+      tag: ${{ steps.create-release.outputs.tag }}
 
   assert:
     runs-on: ubuntu-latest
@@ -42,7 +42,7 @@ jobs:
 
       - uses: ./
         with:
-          release_id: ${{ needs.create-release.outputs.id}}
+          tag: ${{ needs.create-release.outputs.tag }}
           include_regex: "/v0\\.0\\.0-test\\.include\\.*./g" # Should not find a comment
 
       - name: Find Comment (should pass)

action.yml

@@ -13,30 +13,30 @@ inputs:
     required: false
     description: "JavaScript regex used to filter releases."
     default: "/.*/g"
-  release_id:
+  tag:
     required: false
-    description: "The ID of the release. Defaults to `github.event.release.id`."
+    description: "The git tag used to determine the release. If omitted, the release will be determined from `github.event.release.id`."
     default: ""
 runs:
   using: "composite"
   steps:
     - uses: actions/github-script@v7
       env:
-        INPUT_RELEASE_ID: ${{ inputs.release_id }}
+        TAG: ${{ inputs.release_id }}
       with:
         result-encoding: string
         retries: ${{ inputs.retries }}
         script: |
-          const { INPUT_RELEASE_ID } = process.env
+          const { TAG } = process.env
 
           switch(context.eventName) {
             case ('release'):
               break;
             case ('workflow_run'):
               core.warning("This action is designed to run on 'release', not 'workflow_run'. Even when corresponding to a workflow triggered by 'release', 'workflow_run' may not work due to its event context schema.");
               break;
-            case ('pull_request' && INPUT_RELEASE_ID):
-              core.error("This action is meant to only run on 'release'. 'pull_request' is reserved for testing, and 'release_id' was not supplied.");
+            case ('pull_request' && INPUT_RELEASE_NAME):
+              core.error("This action is meant to only run on 'release'. 'pull_request' is reserved for testing, and 'tag' was not supplied.");
               break;
             case ('pull_request'):
               core.warning("This action is meant to only run on 'release'. 'pull_request' is reserved for testing.");
@@ -76,22 +76,24 @@ runs:
             });
           }
 
-          releaseID = INPUT_RELEASE_ID;
-          if (!releaseID) {
-            console.log("Fetching release ID from GitHub context...");
-            releaseID = context.payload.release.id;
-            console.log(`Release ID: releaseID`);
+          releaseTag = TAG;
+          releaseID = null;
+
+          if (releaseTag) {
+            currentReleaseResponse = await github.rest.repos.getReleaseByTag({
+              owner: context.repo.owner,
+              repo: context.repo.repo,            
+              releaseTag,
+            }); 
           } else {
-            console.log(`Using supplied 'release_id': ${releaseID}`);
+            releaseID = context.payload.release.id;
+            currentReleaseResponse = await github.rest.repos.getRelease({
+              owner: context.repo.owner,
+              repo: context.repo.repo,            
+              releaseID,
+            });
           }
 
-          // Fetching details of the current release
-          currentReleaseResponse = await github.rest.repos.getRelease({
-            owner: context.repo.owner,
-            repo: context.repo.repo,            
-            releaseID,
-          });
-
           currentRelease = currentReleaseResponse.data;
 
           // Extracting tag name and target branch from the current release