Merge pull request #61 from ctrf-io/feat/filter-workflow-id

feat: use workflow_id for workflow match

README.md

@@ -402,9 +402,9 @@ current workflow and job names:
 Filtering is applied as follows:
 
 - Runs from the same branch for events of type push and schedule from the same
-  workflow name
+  workflow id
 - Runs from the same pull request for events of type pull_request from the same
-  workflow name
+  workflow id
 
 This ensures that you only see workflow runs that are related to your current
 branch or pull request

package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-actions-ctrf",
-  "version": "0.0.53",
+  "version": "0.0.54",
   "description": "View test results directly within your GitHub workflow summary and Pull Requests",
   "main": "index.js",
   "scripts": {

src/client/github/workflows.ts

@@ -3,6 +3,28 @@ import { components } from '@octokit/openapi-types'
 
 type WorkflowRun = components['schemas']['workflow-run']
 
+/**
+ * Fetches workflow run for a specific run.
+ * @param owner - The owner of the repository.
+ * @param repo - The name of the repository.
+ * @param run_id - The ID of the workflow run.
+ * @returns An array of workflow runs.
+ */
+export async function fetchWorkflowRun(
+  owner: string,
+  repo: string,
+  run_id: number
+): Promise<WorkflowRun> {
+  const octokit = await createGitHubClient()
+  const response = await octokit.actions.getWorkflowRun({
+    owner,
+    repo,
+    run_id
+  })
+
+  return response.data
+}
+
 /**
  * Fetches workflow runs for a specific repo.
  * @param owner - The owner of the repository.

src/ctrf/metrics.ts

@@ -1,6 +1,7 @@
 import { context } from '@actions/github'
 import {
   fetchAllWorkflowRuns,
+  fetchWorkflowRun,
   processArtifactsFromRuns
 } from '../client/github'
 import { filterWorkflowRuns } from '../github'
@@ -228,7 +229,17 @@ export async function processPreviousResultsAndMetrics(
     context.repo.repo
   )
 
-  const filteredRuns = filterWorkflowRuns(workflowRuns, githubContext)
+  const currentWorkflowRun = await fetchWorkflowRun(
+    context.repo.owner,
+    context.repo.repo,
+    githubContext.run_id
+  )
+
+  const filteredRuns = filterWorkflowRuns(
+    workflowRuns,
+    githubContext,
+    currentWorkflowRun
+  )
 
   const reports = await processArtifactsFromRuns(
     filteredRuns,

src/github/helpers.ts

@@ -38,8 +38,8 @@ export function validateCtrfFile(filePath: string): CtrfReport | null {
  */
 export function filterWorkflowRuns(
   runs: WorkflowRun[],
-  // TODO: use GitHub properties
-  githubProperties: GitHubContext
+  githubProperties: GitHubContext,
+  currentRun: WorkflowRun
 ): WorkflowRun[] {
   return runs.filter(run => {
     const isBranchMatch =
@@ -52,9 +52,9 @@ export function filterWorkflowRuns(
         pr => pr.number === githubProperties.pullRequest.number
       )
 
-    const isWorkflowNameMatch = run.name === githubProperties.workflow
+    const isWorkflowMatch = run.workflow_id === currentRun.workflow_id
 
-    if ((isBranchMatch || isPRMatch) && isWorkflowNameMatch) {
+    if ((isBranchMatch || isPRMatch) && isWorkflowMatch) {
       console.debug(
         `Match found for workflow ${run.name} with run number ${run.run_number}`
       )
@@ -64,6 +64,6 @@ export function filterWorkflowRuns(
       )
     }
 
-    return (isBranchMatch || isPRMatch) && isWorkflowNameMatch
+    return (isBranchMatch || isPRMatch) && isWorkflowMatch
   })
 }