Add optional title to disguish notifications

Author: LouisBrunner

.github/workflows/examples.yml

@@ -216,6 +216,7 @@ jobs:
         new: fixtures/file4_added.txt
         mode: addition
         token: ${{ secrets.GITHUB_TOKEN }}
+        title: Works
         notify_issue: true
         notify_check: true
 
@@ -229,5 +230,6 @@ jobs:
         new: fixtures/file2_deleted.txt
         mode: addition
         token: ${{ secrets.GITHUB_TOKEN }}
+        title: Fails
         notify_issue: true
         notify_check: true

README.md

@@ -52,6 +52,10 @@ _Optional_ The path where to output the diff (as well as on the console)
 
 _Optional_ Your `GITHUB_TOKEN`, **required** when using `notify_check` and/or `notify_issue`
 
+### `title`
+
+_Optional_ add a title to the notifications to distinguish between multiple workflows/jobs
+
 ### `notify_check`
 
 _Optional_ Will create a [GitHub Check Run](https://developer.github.com/v3/checks/runs/#create-a-check-run) if `'true'` is specified, **requires** `token` to be given as well

action.yml

@@ -24,6 +24,9 @@ inputs:
   token:
     description: 'your GITHUB_TOKEN, used when sending notifications'
     required: false
+  title:
+    description: 'add a title to the notifications to distinguish between multiple workflows/jobs'
+    required: false
   notify_issue:
     description: 'send a notification to the linked issue/pullrequest with the output'
     required: false

dist/index.js

@@ -22,9 +22,11 @@ export const parseInputs = (getInput: GetInput): Inputs.Args => {
   const notify_check = getInput('notify_check');
   const notify_issue = getInput('notify_issue');
   if (notify_check || notify_issue) {
+    const label = getInput('title');
     const token = getInput('token', {required: true});
     notifications = {
       token,
+      label,
       check: notify_check === 'true',
       issue: notify_issue === 'true',
     };

src/inputs.ts

@@ -19,13 +19,13 @@ async function run(): Promise<void> {
 
       if (inputs.notifications.check) {
         core.debug(`Notification: Check Run`);
-        await createRun(octokit, github.context, result);
+        await createRun(octokit, github.context, result, inputs.notifications.label);
       }
       if (inputs.notifications.issue) {
         core.debug(`Notification: Issue`);
         const issueId = github.context.issue.number;
         if (issueId || issueId === 0) {
-          await createComment(octokit, github.context, result);
+          await createComment(octokit, github.context, result, inputs.notifications.label);
         } else {
           core.debug(`Notification: no issue id`);
         }

src/main.ts

@@ -8,6 +8,7 @@ export type Args = {
 
   notifications?: {
     token: string;
+    label?: string;
     issue: boolean;
     check: boolean;
   };

src/namespaces/Inputs.ts

@@ -6,9 +6,13 @@ const formatDate = (): string => {
   return new Date().toISOString();
 };
 
-const title = 'Smart Diff';
+const getTitle = (label?: string): string => {
+  const more = label ? ` (${label})` : '';
+  return `Smart Diff${more}`;
+};
 
-export const createRun = async (octokit: GitHub, context: Context, result: Result): Promise<void> => {
+export const createRun = async (octokit: GitHub, context: Context, result: Result, label?: string): Promise<void> => {
+  const title = getTitle(label);
   await octokit.checks.create({
     owner: context.repo.owner,
     repo: context.repo.repo,
@@ -26,12 +30,17 @@ export const createRun = async (octokit: GitHub, context: Context, result: Resul
   });
 };
 
-export const createComment = async (octokit: GitHub, context: Context, result: Result): Promise<void> => {
+export const createComment = async (
+  octokit: GitHub,
+  context: Context,
+  result: Result,
+  label?: string,
+): Promise<void> => {
   await octokit.issues.createComment({
     owner: context.repo.owner,
     repo: context.repo.repo,
     issue_number: context.issue.number,
-    body: `## ${title}: ${result.passed ? 'Success' : 'Failure'}
+    body: `## ${getTitle(label)}: ${result.passed ? 'Success' : 'Failure'}
 ${result.summary}
 
 ${result.output}