fix: Add comment identifier

DevCycleHQ · Sep 8, 2023 · 449d559 · 449d559
1 parent 4f56d56
commit 449d559
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 8 deletions.
diff --git a/__tests__/action.test.ts b/__tests__/action.test.ts
@@ -162,7 +162,7 @@ describe('run', () => {
         octokit.rest.issues.listComments = jest.fn().mockReturnValue({ data: [{
             id: 'exisitng-comment-id',
             user: { login: 'github-actions[bot]' },
-            body: `${commentContent} \n Last Updated: Wed, 29 Mar 2023 18:30:39 GMT`
+            body: `${commentContent} \n Last Updated: Wed, 29 Mar 2023 18:30:39 GMT \n <!-- Generated by DevCycle PR Insights -->`
         }] })
 
         await action.run()
@@ -209,7 +209,7 @@ describe('run', () => {
         octokit.rest.issues.listComments = jest.fn().mockReturnValue({ data: [{
             id: 'exisitng-comment-id',
             user: { login: 'github-actions[bot]' },
-            body: 'DevCycle Variable Changes \n Last Updated: Wed, 29 Mar 2023 18:30:39 GMT'
+            body: 'DevCycle Variable Changes \n Last Updated: Wed, 29 Mar 2023 18:30:39 GMT \n <!-- Generated by DevCycle PR Insights -->'
         }] })
 
         await action.run()

diff --git a/dist/index.js b/dist/index.js
@@ -78,7 +78,7 @@ function run() {
             ...authArgs
         ]);
         const pullRequestNumber = pullRequest.number;
-        const changeIdentifier = 'DevCycle Variable Changes';
+        const commentIdentifier = '<!-- Generated by DevCycle PR Insights -->';
         const noChangeIdentifier = 'No DevCycle Variables Changed';
         try {
             const existingComments = yield octokit.rest.issues.listComments({
@@ -87,7 +87,9 @@ function run() {
                 issue_number: pullRequestNumber,
             });
             const commentToUpdate = existingComments === null || existingComments === void 0 ? void 0 : existingComments.data.find((comment) => (comment.user.login === 'github-actions[bot]' &&
-                (comment.body.includes(changeIdentifier) || comment.body.includes(noChangeIdentifier))));
+                (comment.body.includes(commentIdentifier) ||
+                    comment.body.includes('DevCycle Variable Changes') // old comment identifier
+                )));
             const noChanges = output.stdout.includes(noChangeIdentifier);
             if (noChanges && onlyCommentOnChange) {
                 if (commentToUpdate) {
@@ -99,7 +101,8 @@ function run() {
                 }
                 return;
             }
-            const commentBody = `${output.stdout} \n\n Last Updated: ${(new Date()).toUTCString()}`;
+            let commentBody = `${output.stdout} \n\n Last Updated: ${(new Date()).toUTCString()}`;
+            commentBody += `\n${commentIdentifier}`;
             if (commentToUpdate) {
                 yield octokit.rest.issues.updateComment({
                     owner,

diff --git a/src/action.ts b/src/action.ts
@@ -53,7 +53,7 @@ export async function run() {
     )
 
     const pullRequestNumber = pullRequest.number
-    const changeIdentifier = 'DevCycle Variable Changes'
+    const commentIdentifier = '<!-- Generated by DevCycle PR Insights -->'
     const noChangeIdentifier = 'No DevCycle Variables Changed'
 
     try {
@@ -65,7 +65,10 @@ export async function run() {
 
         const commentToUpdate = existingComments?.data.find((comment: any) => (
             comment.user.login === 'github-actions[bot]' &&
-            (comment.body.includes(changeIdentifier) || comment.body.includes(noChangeIdentifier))
+            (
+                comment.body.includes(commentIdentifier) ||
+                comment.body.includes('DevCycle Variable Changes') // old comment identifier
+            )
         ))
 
         const noChanges = output.stdout.includes(noChangeIdentifier)
@@ -80,7 +83,8 @@ export async function run() {
             return
         }
 
-        const commentBody = `${output.stdout} \n\n Last Updated: ${(new Date()).toUTCString()}`
+        let commentBody = `${output.stdout} \n\n Last Updated: ${(new Date()).toUTCString()}`
+        commentBody += `\n${commentIdentifier}`
         if (commentToUpdate) {
             await octokit.rest.issues.updateComment({
                 owner,