feat: add support for sticky comment notifications

Author: LouisBrunner

.github/workflows/examples.yml

@@ -78,6 +78,15 @@ _Optional_ Will create a [GitHub Check Run](https://developer.github.com/v3/chec
 
 _Optional_ Will create a comment in the linked issue if `'true'` is specified, **requires** `token` to be given as well
 
+### `sticky_comment`
+
+_Optional_ When using `notify_issue: true`, will edit the created comment instead of creating a new one everytime.
+
+Note that the updated comment is based on the `title`. Thus:
+
+* if you call the action multiple times in your workflow, make sure the titles are unique to each call to avoid overwriting the same comment
+* make sure the titles are the same between different calls to the action if you want to update the same comment
+
 ## Outputs
 
 ### `passed`

README.md

@@ -29,6 +29,9 @@ inputs:
   notify_issue:
     description: 'send a notification to the linked issue/pullrequest with the output'
     required: false
+  sticky_comment:
+    description: 'will edit the created comment instead of creating a new one everytime'
+    required: false
   notify_check:
     description: 'create a check run with the output'
     required: false

action.yml

@@ -25,6 +25,7 @@ export const parseInputs = (getInput: GetInput): Inputs.Args => {
   let notifications;
   const notify_check = getInput('notify_check');
   const notify_issue = getInput('notify_issue');
+  const sticky_comment = getInput('sticky_comment');
   if (notify_check || notify_issue) {
     const label = getInput('title');
     const token = getInput('token', {required: true});
@@ -33,6 +34,7 @@ export const parseInputs = (getInput: GetInput): Inputs.Args => {
       label,
       check: notify_check === 'true',
       issue: notify_issue === 'true',
+      sticky: sticky_comment === 'true',
     };
   }
 

dist/index.js

@@ -3,7 +3,7 @@ import * as github from '@actions/github';
 import fs from 'fs';
 import {parseInputs} from './inputs';
 import {processDiff} from './processing';
-import {createRun, createComment} from './notifications';
+import {createRun, upsertComment} from './notifications';
 
 async function run(): Promise<void> {
   try {
@@ -25,7 +25,7 @@ async function run(): Promise<void> {
         core.debug(`Notification: Issue`);
         const issueId = github.context.issue.number;
         if (issueId || issueId === 0) {
-          await createComment(octokit, github.context, result, inputs.notifications.label);
+          await upsertComment(octokit, github.context, result, inputs.notifications.label);
         } else {
           core.debug(`Notification: no issue id`);
         }

package-lock.json

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

src/inputs.ts

@@ -35,7 +35,21 @@ export const createRun = async (
   });
 };
 
-export const createComment = async (
+const commentLocator = (label?: string): string => {
+  return `<!-- Diff Action / Pull Request Comment / ${label ?? ''} -->`;
+};
+
+const commentBody = (label: string | undefined, result: Result): string => {
+  return `${commentLocator(label)}## ${getTitle(label)}: ${result.passed ? 'Success' : 'Failure'}
+${result.summary}
+
+\`\`\`
+${result.output}
+\`\`\`
+`;
+};
+
+const createComment = async (
   octokit: InstanceType<typeof GitHub>,
   context: Context,
   result: Result,
@@ -45,12 +59,56 @@ export const createComment = async (
     owner: context.repo.owner,
     repo: context.repo.repo,
     issue_number: context.issue.number,
-    body: `## ${getTitle(label)}: ${result.passed ? 'Success' : 'Failure'}
-${result.summary}
+    body: commentBody(label, result),
+  });
+};
 
-\`\`\`
-${result.output}
-\`\`\`
-`,
+const updateComment = async (
+  octokit: InstanceType<typeof GitHub>,
+  context: Context,
+  comment_id: number,
+  result: Result,
+  label?: string,
+): Promise<void> => {
+  await octokit.rest.issues.updateComment({
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+    comment_id: comment_id,
+    body: commentBody(label, result),
   });
 };
+
+const findComment = async (
+  octokit: InstanceType<typeof GitHub>,
+  context: Context,
+  label?: string,
+): Promise<undefined | number> => {
+  const {viewer}: {viewer: {login?: string}} = await octokit.graphql('query { viewer { login } }');
+  const locator = commentLocator(label);
+  for await (const entry of octokit.paginate.iterator(octokit.rest.issues.listComments, {
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+    issue_number: context.issue.number,
+  })) {
+    for (const comment of entry.data) {
+      console.log('USER', comment.user, viewer.login);
+      if (comment.body?.startsWith(locator) && comment.user?.login === viewer.login) {
+        return comment.id;
+      }
+    }
+  }
+};
+
+export const upsertComment = async (
+  octokit: InstanceType<typeof GitHub>,
+  context: Context,
+  result: Result,
+  label?: string,
+): Promise<void> => {
+  const comment_id = await findComment(octokit, context, label);
+  if (comment_id !== undefined) {
+    await updateComment(octokit, context, comment_id, result, label);
+  } else {
+    await createComment(octokit, context, result, label);
+  }
+};