Merge pull request #230 from roryabraham/Rory-AddWorkflowRunAttachment

Add workflowRun field
8398a7 · Nov 26, 2022 · 2780b65 · 2780b65
2 parents d64b11c + 7c86ac7
commit 2780b65
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/content/usage/fields.md b/docs/content/usage/fields.md
@@ -32,6 +32,7 @@ Corresponding types are as follows.
 | eventName   | `AS_EVENT_NAME`         | trigger event name                                          |
 | ref         | `AS_REF`                | git reference                                               |
 | workflow    | `AS_WORKFLOW`           | Generate a workflow link from git sha                       |
+| workflowRun | `AS_WORKFLOW_RUN`       | Generate a link to the present workflow run                 |
 | message     | `AS_MESSAGE`            | commit message                                              |
 | author      | `AS_AUTHOR`             | The author who pushed                                       |
 | job         | `AS_JOB`                | Generate a job run link of the job that was executed        |

diff --git a/src/fields.ts b/src/fields.ts
@@ -73,6 +73,9 @@ export class FieldFactory {
         this.includes('workflow')
           ? createAttachment('workflow', await this.workflow())
           : undefined,
+        this.includes('workflowRun')
+          ? createAttachment('workflow', await this.workflowRun())
+          : undefined,
         this.includes('pullRequest')
           ? createAttachment('pullRequest', await this.pullRequest())
           : undefined,
@@ -214,6 +217,13 @@ export class FieldFactory {
     return value;
   }
 
+  private async workflowRun(): Promise<string> {
+    const { owner, repo } = context.repo;
+    const value = `<${this.gitHubBaseUrl}/${owner}/${repo}/actions/runs/${context.runId}|${context.workflow}>`;
+    process.env.AS_WORKFLOW_RUN = value;
+    return value;
+  }
+
   private async pullRequest(): Promise<string> {
     let value;
     if (context.eventName.startsWith('pull_request')) {