Merge pull request #46 from gscho/output-jira-key

Output a JIRA key if found.
cakeinpanic · Jun 21, 2024 · 235b829 · 235b829
2 parents 21bed2b + 1da4052
commit 235b829
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -48,6 +48,7 @@ jobs:
 
 | key                    | description                                                                                                                                                                                                                                                                                                     
 | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `jira-issue-key`         | The JIRA issue key. If key is not found the value is an empty string |****
 | `jira-issue-found`         | Indication whether a jira issue was found or not |
 | `jira-issue-source`         | Indication how the jira issue was found, by - `branch \| pr-title \| null` |
 

diff --git a/action.yml b/action.yml
@@ -31,6 +31,8 @@ inputs:
       required: false
       default: 'false'
 outputs:
+  jira-issue-key:
+    description: 'The JIRA issue key. If key is not found the value is an empty string'
   jira-issue-found:
     description: 'Indication whether a jira issue was found or not'
   jira-issue-source:

diff --git a/src/main.ts b/src/main.ts
@@ -16,12 +16,12 @@ async function run(): Promise<void> {
 
     if (!githubConnector.isPRAction) {
       console.log('This action meant to be run only on PRs');
-      setOutputs(false, null);
+      setOutputs(null, null);
       process.exit(0);
     }
 
     if (shouldSkipBranch(githubConnector.headBranch, BRANCH_IGNORE_PATTERN)) {
-      setOutputs(false, null);
+      setOutputs(null, null);
       process.exit(0);
     }
 
@@ -30,11 +30,11 @@ async function run(): Promise<void> {
     const details = await jiraConnector.getTicketDetails(key);
     await githubConnector.updatePrDetails(details);
 
-    setOutputs(true, source);
+    setOutputs(key, source);
   } catch (error) {
     console.log('Failed to add JIRA description to PR.');
     core.error(error.message);
-    setOutputs(false, null);
+    setOutputs(null, null);
     if (FAIL_WHEN_JIRA_ISSUE_NOT_FOUND) {
       core.setFailed(error.message);
       process.exit(1);
@@ -44,7 +44,9 @@ async function run(): Promise<void> {
   }
 }
 
-function setOutputs(isFound: boolean, source: ESource | null): void {
+function setOutputs(key: string | null, source: ESource | null): void {
+  var isFound = key !== null;
+  core.setOutput('jira-issue-key', key);
   core.setOutput('jira-issue-found', isFound);
   core.setOutput('jira-issue-source', source || 'null');
 }