Rework getWorkflowRunId()

Ludovic TOURMAN · Ludovic TOURMAN · commit 125042ea754f · 2023-12-29T12:27:55.000+01:00
diff --git a/README.md b/README.md
@@ -11,77 +11,94 @@ For details of the `workflow_dispatch` even see [this blog post introducing this
 
 *Note 2.* If you want to reference the target workflow by ID, you will need to list them with the following REST API call `curl https://api.github.com/repos/{{owner}}/{{repo}}/actions/workflows -H "Authorization: token {{pat-token}}"`
 
-_This action is a fork of `benc-uk/workflow-dispatch` to add support for waiting for workflow completion._
+*This action is a fork of `benc-uk/workflow-dispatch` to add support for waiting for workflow completion.*
 
 ## Inputs
+
 ### `workflow`
+
 > **Required.** The name or the filename or ID of the workflow to trigger and run.
 
 ### `token`
 
 > **Required.** A GitHub access token (PAT) with write access to the repo in question. 
-> 
+>
 > **NOTE.** The automatically provided token e.g. `${{ secrets.GITHUB_TOKEN }}` can not be used, GitHub prevents this token from being able to fire the  `workflow_dispatch` and `repository_dispatch` event. [The reasons are explained in the docs](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#triggering-new-workflows-using-a-personal-access-token).  
 > The solution is to manually create a PAT and store it as a secret e.g. `${{ secrets.PERSONAL_TOKEN }}`
 
 ### `inputs`
+
 > **Optional.** The inputs to pass to the workflow (if any are configured), this must be a JSON encoded string, e.g. `{ "myInput": "foobar" }`.
 >
 > All values must be strings (even if they are used as booleans or numbers in the triggered workflow). The triggered workflow should use `fromJson` function to get the right type
 
 ### `ref`
+
 > **Optional.** The Git reference used with the triggered workflow run. The reference can be a branch, tag, or a commit SHA. If omitted the context ref of the triggering workflow is used. If you want to trigger on pull requests and run the target workflow in the context of the pull request branch, set the ref to `${{ github.event.pull_request.head.ref }}`
 
 ### `repo`
+
 > **Optional.** The default behavior is to trigger workflows in the same repo as the triggering workflow, if you wish to trigger in another GitHub repo "externally", then provide the owner + repo name with slash between them e.g. `microsoft/vscode`
 
 ### `run-name` (since 3.0.0)
+
 > **Optional.** The default behavior is to get the remote run ID based on the latest workflow name and date, if you have multiple of the same workflow running at the same time it can point to an incorrect run id.
-> You can specify the run name to fetch the run ID based on the actual run name.
+> To prevent from this, you can specify a unique run name to fetch the concerned run ID. It will also requires you to set that same value as an input for your remote workflow (See the [corresponding example](#invoke-workflow-with-a-unique-run-name-since-300))
 
 ### `wait-for-completion`
+
 > **Optional.** If `true`, this action will actively poll the workflow run to get the result of the triggered workflow. It is enabled by default. If the triggered workflow fails due to either `failure`, `timed_out` or `cancelled` then the step that has triggered the other workflow will be marked as failed too.
 
 ### `wait-for-completion-timeout`
+
 > **Optional.** The time to wait to mark triggered workflow has timed out. The time must be suffixed by the time unit e.g. `10m`. Time unit can be `s` for seconds, `m` for minutes and `h` for hours. It has no effect if `wait-for-completion` is `false`. Default is `1h`
 
 ### `wait-for-completion-interval`
+
 > **Optional.** The time to wait between two polls for getting run status. The time must be suffixed by the time unit e.g. `10m`. Time unit can be `s` for seconds, `m` for minutes and `h` for hours. It has no effect if `wait-for-completion` is `false`. Default is `1m`.
-> 
+>
 > **/!\ Do not use a value that is too small to avoid `API Rate limit exceeded`**
 
 ### `display-workflow-run-url`
+
 > **Optional.** If `true`, it displays in logs the URL of the triggered workflow. It is useful to follow the progress of the triggered workflow. It is enabled by default.
 
 ### `display-workflow-run-url-timeout`
+
 > **Optional.** The time to wait for getting the workflow run URL. If the timeout is reached, it doesn't fail and continues. Displaying the workflow URL is just for information purpose. The time must be suffixed by the time unit e.g. `10m`. Time unit can be `s` for seconds, `m` for minutes and `h` for hours. It has no effect if `display-workflow-run-url` is `false`. Default is `10m`
 
 ### `display-workflow-run-url-interval`
+
 > **Optional.** The time to wait between two polls for getting workflow run URL. The time must be suffixed by the time unit e.g. `10m`. Time unit can be `s` for seconds, `m` for minutes and `h` for hours. It has no effect if `display-workflow-run-url` is `false`. Default is `1m`.
-> 
+>
 > **/!\ Do not use a value that is too small to avoid `API Rate limit exceeded`**
 
 ### `workflow-logs`
+
 > **Optional.** Indicate what to do with logs of the triggered workflow:
-> 
+>
 > * `print`: Retrieve the logs for each job of the triggered workflow and print into the logs of the job that triggered the workflow.
 > * `ignore`: Do not retrieve log of triggered workflow at all (default).
-> 
-> Only available when `wait-for-completion` is `true`. 
-> 
+>
+> Only available when `wait-for-completion` is `true`.
+>
 > Default is `ignore`.
 
-
 ## Outputs
+
 ### `workflow-url`
+
 > The URL of the workflow run that has been triggered. It may be undefined if the URL couldn't be retrieved (timeout reached) or if `wait-for-completion` and `display-workflow-run-url` are > both `false`
 
 ### `workflow-conclusion`
+
 > The result of the triggered workflow. May be one of `success`, `failure`, `cancelled`, `timed_out`, `skipped`, `neutral`, `action_required`. The step in your workflow will fail if the triggered workflow completes with `failure`, `cancelled` or `timed_out`. Other workflow conlusion are considered success.
 > Only available if `wait-for-completion` is `true`
 
-
 ## Example usage
+
+### Invoke workflow without inputs. Wait for result
+
 ```yaml
 - name: Invoke workflow without inputs. Wait for result
   uses: aurelien-baudet/workflow-dispatch@v2
@@ -90,6 +107,8 @@ _This action is a fork of `benc-uk/workflow-dispatch` to add support for waiting
     token: ${{ secrets.PERSONAL_TOKEN }}
 ```
 
+### Invoke workflow without inputs. Don't wait for result
+
 ```yaml
 - name: Invoke workflow without inputs. Don't wait for result
   uses: aurelien-baudet/workflow-dispatch@v2
@@ -99,6 +118,8 @@ _This action is a fork of `benc-uk/workflow-dispatch` to add support for waiting
     wait-for-completion: false
 ```
 
+### Invoke workflow with inputs
+
 ```yaml
 - name: Invoke workflow with inputs
   uses: aurelien-baudet/workflow-dispatch@v2
@@ -108,6 +129,8 @@ _This action is a fork of `benc-uk/workflow-dispatch` to add support for waiting
     inputs: '{ "message": "blah blah", "debug": true }'
 ```
 
+### Invoke workflow in another repo with inputs
+
 ```yaml
 - name: Invoke workflow in another repo with inputs
   uses: aurelien-baudet/workflow-dispatch@v2
@@ -118,6 +141,8 @@ _This action is a fork of `benc-uk/workflow-dispatch` to add support for waiting
     inputs: '{ "message": "blah blah", "debug": true }'
 ```
 
+### Invoke workflow and handle result
+
 ```yaml
 - name: Invoke workflow and handle result
   id: trigger-step
@@ -130,6 +155,38 @@ _This action is a fork of `benc-uk/workflow-dispatch` to add support for waiting
   run: echo "Another Workflow conclusion: ${{ steps.trigger-step.outputs.workflow-conclusion }}"
 ```
 
+### Invoke workflow with a unique run name (since 3.0.0)
+
+```yaml
+- name: Invoke workflow and handle result
+  id: trigger-step
+  uses: aurelien-baudet/workflow-dispatch@v3
+  env:
+    RUN_NAME: ${{ github.repository }}/actions/runs/${{ github.run_id }}
+  with:
+    run-name: ${{ env.RUN_NAME }}
+    workflow: Another Workflow
+    token: ${{ secrets.PERSONAL_TOKEN }}
+    inputs: >-
+      {
+        "run-name": "${{ env.RUN_NAME }}"
+      }
+```
+
+:warning: In you remote workflow, you will need to forward and use the `run-name` input (See [GitHub Action run-name](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#run-name))
+
+```yaml
+name: Another Workflow
+run-name: ${{ inputs.run-name }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      run-name:
+        description: 'The distinct run name used to retrieve the run ID. Defaults to the workflow name'
+        type: string
+        required: false
+```
 
 ## Contributions
 
@@ -139,4 +196,4 @@ Thanks to:
 * [rui-ferreira](https://github.com/rui-ferreira)
 * [robbertvdg](https://github.com/robbertvdg)
 * [samit2040](https://github.com/samit2040)
-* [jonas-schievink](https://github.com/jonas-schievink)
+* [jonas-schievink](https://github.com/jonas-schievink)
diff --git a/dist/index.js b/dist/index.js
@@ -10092,13 +10092,36 @@ class WorkflowHandler {
                 return this.workflowRunId;
             }
             try {
-                core.debug('Get workflow run id');
+                const workflowId = yield this.getWorkflowId();
+                const response = yield this.octokit.rest.actions.listWorkflowRuns({
+                    owner: this.owner,
+                    repo: this.repo,
+                    workflow_id: workflowId,
+                    event: 'workflow_dispatch',
+                    branch: this.ref,
+                    created: `>=${new Date(this.triggerDate).toISOString()}`
+                });
+                (0, debug_1.debug)('List Workflow Runs', response);
+                let runs = response.data.workflow_runs;
                 if (this.runName) {
-                    this.workflowRunId = yield this.findWorklowRunIdFromRunName(this.runName);
+                    runs = response.data.workflow_runs
+                        .filter((r) => r.name == this.runName);
                 }
-                else {
-                    this.workflowRunId = yield this.findWorkflowRunIdFromFirstRunOfSameWorkflowId();
+                if (runs.length == 0) {
+                    throw new Error('Run not found');
+                }
+                if (runs.length > 1) {
+                    core.warning(`Found ${runs.length} runs. Using the last one.`);
+                    (0, debug_1.debug)(`Filtered Workflow Runs (after trigger date: ${new Date(this.triggerDate).toISOString()})`, runs.map((r) => ({
+                        id: r.id,
+                        name: r.name,
+                        created_at: r.created_at,
+                        triggerDate: new Date(this.triggerDate).toISOString(),
+                        created_at_ts: new Date(r.created_at).valueOf(),
+                        triggerDateTs: this.triggerDate
+                    })));
                 }
+                this.workflowRunId = runs[0].id;
                 return this.workflowRunId;
             }
             catch (error) {
@@ -10107,47 +10130,6 @@ class WorkflowHandler {
             }
         });
     }
-    findWorkflowRunIdFromFirstRunOfSameWorkflowId() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const workflowId = yield this.getWorkflowId();
-            const response = yield this.octokit.rest.actions.listWorkflowRuns({
-                owner: this.owner,
-                repo: this.repo,
-                workflow_id: workflowId,
-                event: 'workflow_dispatch'
-            });
-            (0, debug_1.debug)('List Workflow Runs', response);
-            const runs = response.data.workflow_runs
-                .filter((r) => new Date(r.created_at).setMilliseconds(0) >= this.triggerDate);
-            (0, debug_1.debug)(`Filtered Workflow Runs (after trigger date: ${new Date(this.triggerDate).toISOString()})`, runs.map((r) => ({
-                id: r.id,
-                name: r.name,
-                created_at: r.creatd_at,
-                triggerDate: new Date(this.triggerDate).toISOString(),
-                created_at_ts: new Date(r.created_at).valueOf(),
-                triggerDateTs: this.triggerDate
-            })));
-            if (runs.length == 0) {
-                throw new Error('Run not found');
-            }
-            return runs[0].id;
-        });
-    }
-    findWorklowRunIdFromRunName(runName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const result = yield this.octokit.rest.checks.listForRef({
-                check_name: runName,
-                owner: this.owner,
-                repo: this.repo,
-                ref: this.ref,
-                filter: 'latest'
-            });
-            if (result.length == 0) {
-                throw new Error('Run not found');
-            }
-            return result.check_runs[0].id;
-        });
-    }
     getWorkflowId() {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.workflowId) {
diff --git a/src/workflow-handler.ts b/src/workflow-handler.ts
@@ -36,8 +36,8 @@ const ofConclusion = (conclusion: string | null): WorkflowRunConclusion => {
 }
 
 export interface WorkflowRunResult {
-  url: string, 
-  status: WorkflowRunStatus, 
+  url: string,
+  status: WorkflowRunStatus,
   conclusion: WorkflowRunConclusion
 }
 
@@ -127,64 +127,48 @@ export class WorkflowHandler {
       return this.workflowRunId;
     }
     try {
-      core.debug('Get workflow run id');
+      const workflowId = await this.getWorkflowId();
+
+      const response = await this.octokit.rest.actions.listWorkflowRuns({
+        owner: this.owner,
+        repo: this.repo,
+        workflow_id: workflowId,
+        event: 'workflow_dispatch',
+        branch: this.ref,
+        created: `>=${new Date(this.triggerDate).toISOString()}`
+      });
+
+      debug('List Workflow Runs', response);
+
+      let runs = response.data.workflow_runs;
       if (this.runName) {
-        this.workflowRunId = await this.findWorklowRunIdFromRunName(this.runName);
-      } else {
-        this.workflowRunId = await this.findWorkflowRunIdFromFirstRunOfSameWorkflowId();
+        runs = response.data.workflow_runs
+          .filter((r: any) => r.name == this.runName)
+      }
+
+      if (runs.length == 0) {
+        throw new Error('Run not found');
+      }
+
+      if (runs.length > 1) {
+        core.warning(`Found ${runs.length} runs. Using the last one.`);
+        debug(`Filtered Workflow Runs (after trigger date: ${new Date(this.triggerDate).toISOString()})`, runs.map((r: any) => ({
+          id: r.id,
+          name: r.name,
+          created_at: r.created_at,
+          triggerDate: new Date(this.triggerDate).toISOString(),
+          created_at_ts: new Date(r.created_at).valueOf(),
+          triggerDateTs: this.triggerDate
+        })));
       }
 
+      this.workflowRunId = runs[0].id as number;
+
       return this.workflowRunId;
     } catch (error) {
       debug('Get workflow run id error', error);
       throw error;
     }
-
-  }
-
-  private async findWorkflowRunIdFromFirstRunOfSameWorkflowId(): Promise<number> {
-    const workflowId = await this.getWorkflowId();
-
-    const response = await this.octokit.rest.actions.listWorkflowRuns({
-      owner: this.owner,
-      repo: this.repo,
-      workflow_id: workflowId,
-      event: 'workflow_dispatch'
-    });
-
-    debug('List Workflow Runs', response);
-    const runs = response.data.workflow_runs
-      .filter((r: any) => new Date(r.created_at).setMilliseconds(0) >= this.triggerDate);
-    debug(`Filtered Workflow Runs (after trigger date: ${new Date(this.triggerDate).toISOString()})`, runs.map((r: any) => ({
-      id: r.id,
-      name: r.name,
-      created_at: r.creatd_at,
-      triggerDate: new Date(this.triggerDate).toISOString(),
-      created_at_ts: new Date(r.created_at).valueOf(),
-      triggerDateTs: this.triggerDate
-    })));
-
-    if (runs.length == 0) {
-      throw new Error('Run not found');
-    }
-
-    return runs[0].id as number;
-  }
-
-  private async findWorklowRunIdFromRunName(runName: string): Promise<number> {
-    const result = await this.octokit.rest.checks.listForRef({
-      check_name: runName,
-      owner: this.owner,
-      repo: this.repo,
-      ref: this.ref,
-      filter: 'latest'
-    });
-
-    if (result.length == 0) {
-      throw new Error('Run not found');
-    }
-
-    return result.check_runs[0].id as number;
   }
 
   private async getWorkflowId(): Promise<number | string> {
@@ -198,7 +182,7 @@ export class WorkflowHandler {
     }
     try {
       const workflowsResp = await this.octokit.rest.actions.listRepoWorkflows({
-        owner: this.owner, 
+        owner: this.owner,
         repo: this.repo
       });
       const workflows = workflowsResp.data.workflows;
