Add input to configure GitHub Actions workflow filename (#44)

* Enable configuring the GITHUB_BASELINE_WORKFLOW_REF

* Update Inputs section in README.md

* Add required: false

Author: fgrosse

README.md

@@ -114,7 +114,7 @@ jobs:
 ```yaml
 inputs:
   version:
-    description: 'The exact version of the go-coverage-report tool to use.'
+    description: 'The exact version tag of the go-coverage-report tool to use.'
     required: true
     default: "v1.1.1"
 
@@ -142,16 +142,25 @@ inputs:
     required: false
     default: "github.com/${{ github.repository }}"
 
-  trim:
-    description: 'Trim a prefix in the "Impacted Packages" column of the markdown report.'
-    required: false
-
   skip-comment:
     description: |
       Skip creating or updating the pull request comment. This may be useful when you want
       to generate the coverage report and modify it in your own scripts.
     required: false
     default: 'false'
+
+  trim:
+    description: Trim a prefix in the "Impacted Packages" column of the markdown report.
+    required: false
+
+  github-baseline-workflow-ref:
+    description: |
+      The ref of the GitHub actions Workflow that produces the baseline coverage.
+      By default, the GitHub Actions Workflow ref is used
+      (e.g. "octocat/hello-world/.github/workflows/my-workflow.yml@refs/heads/my_branch").
+      You can aso just pass the name of the Workflow file directly (e.g. "my-workflow.yml").
+    default: ${{ github.workflow_ref }}
+    required: false
 ```
 
 ### Outputs

action.yml

@@ -46,6 +46,15 @@ inputs:
     description: Trim a prefix in the "Impacted Packages" column of the markdown report.
     required: false
 
+  github-baseline-workflow-ref:
+    description: |
+      The ref of the GitHub actions Workflow that produces the baseline coverage.
+      By default, the GitHub Actions Workflow ref is used
+      (e.g. "octocat/hello-world/.github/workflows/my-workflow.yml@refs/heads/my_branch").
+      You can aso just pass the name of the Workflow file directly (e.g. "my-workflow.yml").
+    default: ${{ github.workflow_ref }}
+    required: false
+
 outputs:
   coverage_report:
     description: 'The generated coverage report in Markdown format.'
@@ -81,8 +90,8 @@ runs:
       env:
         GH_REPO: ${{ github.repository }}
         GH_TOKEN: ${{ github.token }}
-        GITHUB_WORKFLOW_REF: ${{ github.workflow_ref }}
-        GITHUB_BASE_REF: ${{ github.base_ref }}
+        GITHUB_BASELINE_WORKFLOW_REF: ${{ inputs.github-baseline-workflow-ref }}
+        TARGET_BRANCH: ${{ github.base_ref }}
         CHANGED_FILES_PATH: .github/outputs/all_modified_files.json
         COVERAGE_ARTIFACT_NAME: ${{ inputs.coverage-artifact-name }}
         COVERAGE_FILE_NAME: ${{ inputs.coverage-file-name }}

scripts/github-action.sh

@@ -24,9 +24,9 @@ this in the workflow file:
      env: …
 
 You can use the following environment variables to configure the script:
-- GITHUB_WORKFLOW: The name of the Workflow (default: CI)
-- GITHUB_WORKFLOW_REF: The ref path to the workflow to use instead of GITHUB_WORKFLOW (optional)
-- GITHUB_BASE_REF: The base branch to compare the coverage results against (default: main)
+- GITHUB_BASELINE_WORKFLOW: The name of the GitHub actions Workflow that produces the baseline coverage (default: CI)
+- GITHUB_BASELINE_WORKFLOW_REF: The ref path to the workflow to use instead of GITHUB_BASELINE_WORKFLOW (optional)
+- TARGET_BRANCH: The base branch to compare the coverage results against (default: main)
 - COVERAGE_ARTIFACT_NAME: The name of the artifact containing the code coverage results (default: code-coverage)
 - COVERAGE_FILE_NAME: The name of the file containing the code coverage results (default: coverage.txt)
 - CHANGED_FILES_PATH: The path to the file containing the list of changed files (default: .github/outputs/all_modified_files.json)
@@ -44,8 +44,8 @@ fi
 GITHUB_REPOSITORY=$1
 GITHUB_PULL_REQUEST_NUMBER=$2
 GITHUB_RUN_ID=$3
-GITHUB_WORKFLOW=${GITHUB_WORKFLOW:-CI}
-TARGET_BRANCH=${GITHUB_BASE_REF:-main}
+GITHUB_BASELINE_WORKFLOW=${GITHUB_BASELINE_WORKFLOW:-CI}
+TARGET_BRANCH=${TARGET_BRANCH:-main}
 COVERAGE_ARTIFACT_NAME=${COVERAGE_ARTIFACT_NAME:-code-coverage}
 COVERAGE_FILE_NAME=${COVERAGE_FILE_NAME:-coverage.txt}
 
@@ -75,9 +75,9 @@ if [[ -z ${GITHUB_OUTPUT+x} ]]; then
     exit 1
 fi
 
-# If GITHUB_WORKFLOW_REF is defined, extract the workflow file path from it and use it instead of GITHUB_WORKFLOW
-if [[ -n ${GITHUB_WORKFLOW_REF+x} ]]; then
-    GITHUB_WORKFLOW=$(basename "${GITHUB_WORKFLOW_REF%%@*}")
+# If GITHUB_BASELINE_WORKFLOW_REF is defined, extract the workflow file path from it and use it instead of GITHUB_BASELINE_WORKFLOW
+if [[ -n ${GITHUB_BASELINE_WORKFLOW_REF+x} ]]; then
+    GITHUB_BASELINE_WORKFLOW=$(basename "${GITHUB_BASELINE_WORKFLOW_REF%%@*}")
 fi
 
 export GH_REPO="$GITHUB_REPOSITORY"
@@ -99,7 +99,7 @@ rm -r "/tmp/gh-run-download-$GITHUB_RUN_ID"
 end_group
 
 start_group "Download code coverage results from target branch"
-LAST_SUCCESSFUL_RUN_ID=$(gh run list --status=success --branch="$TARGET_BRANCH" --workflow="$GITHUB_WORKFLOW" --event=push --json=databaseId --limit=1 -q '.[] | .databaseId')
+LAST_SUCCESSFUL_RUN_ID=$(gh run list --status=success --branch="$TARGET_BRANCH" --workflow="$GITHUB_BASELINE_WORKFLOW" --event=push --json=databaseId --limit=1 -q '.[] | .databaseId')
 if [ -z "$LAST_SUCCESSFUL_RUN_ID" ]; then
   echo "::error::No successful run found on the target branch"
   exit 1