Add output "ticketNumber"

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+- Added output `ticketNumber` and option `outptOnly`.
+
 ## 2.0.0 (Apr 20, 2023)
 Set action node version to 16
 

action.yml

@@ -62,6 +62,11 @@ inputs:
     default: 'true'
     required: false
 
+  outputOnly:
+    description: 'Do not post any comment; output ticket number only'
+    default: 'false'
+    required: false
+
   token:
     description: 'GitHub authentication token'
     required: true
@@ -70,6 +75,10 @@ inputs:
     description: 'Ticket URL with `%ticketNumber%` placeholder'
     required: false
 
+outputs:
+  ticketNumber:
+    description: 'The extracted ticket number'
+
 runs:
   using: 'node16'
   main: 'build/index.js'

src/ticket-check-action.ts

@@ -1,4 +1,4 @@
-import { debug as log, getInput, setFailed } from '@actions/core';
+import { debug as log, getInput, setFailed, setOutput } from '@actions/core';
 import { context, getOctokit } from '@actions/github';
 
 // Helper function to retrieve ticket number from a string (either a shorthand reference or a full URL)
@@ -33,6 +33,7 @@ export async function run(): Promise<void> {
     const ticketLink = getInput('ticketLink', { required: false });
     const titleRegex = new RegExp(titleRegexBase, titleRegexFlags);
     const titleCheck = titleRegex.exec(title);
+    const outputOnly: boolean = getInput('outputOnly', { required: false }) === 'true';
 
     // Instantiate a GitHub Client instance
     const token = getInput('token', { required: true });
@@ -49,6 +50,10 @@ export async function run(): Promise<void> {
       .split(',')
       .map((user) => user.trim());
 
+      /**
+       * Determines the ticket link and adds the link as review.
+       * In case "outputOnly" is active, it just sets the output "ticketNumber" and returns without adding a review.
+       */
     const linkTicket = async (matchArray: RegExpMatchArray): Promise<void> => {
       debug('match array for linkTicket', JSON.stringify(matchArray));
       debug('match array groups for linkTicket', JSON.stringify(matchArray.groups));
@@ -62,6 +67,12 @@ export async function run(): Promise<void> {
       if (!ticketNumber) {
         debug('ticketNumber not found', 'ticketNumber group not found in match array.');
 
+        return undefined;
+      }
+
+      setOutput("ticketNumber", ticketNumber);
+
+      if (outputOnly) {
         return;
       }
 
@@ -123,6 +134,12 @@ export async function run(): Promise<void> {
         return;
       }
 
+      if (outputOnly) {
+        setOutput("ticketNumber", id);
+
+        return;
+      }
+
       let newTitle = '';
 
       if (titleFormat.includes('%id%') && id && !title.includes(id)) {
@@ -171,7 +188,7 @@ export async function run(): Promise<void> {
     debug('exempt users', exemptUsers.join(','));
     debug('ticket link', ticketLink);
 
-    if (sender && exemptUsers.includes(sender)) {
+    if (!outputOnly && sender && exemptUsers.includes(sender)) {
       debug('success', 'User is listed as exempt');
 
       return;
@@ -206,6 +223,12 @@ export async function run(): Promise<void> {
         return;
       }
 
+      if (outputOnly) {
+        setOutput("ticketNumber", id);
+
+        return;
+      }
+
       let newTitle = '';
 
       if (titleFormat.includes('%id%') && id && !title.includes(id)) {
@@ -284,6 +307,12 @@ export async function run(): Promise<void> {
         return;
       }
 
+      if (outputOnly) {
+        setOutput("ticketNumber", id);
+
+        return;
+      }
+
       let newTitle = '';
 
       if (titleFormat.includes('%id%') && id && !title.includes(id)) {