Merge pull request #5 from marocchino/3-comment-header

comment header

Author: marocchino

.gitignore

@@ -91,3 +91,5 @@ typings/
 
 # DynamoDB Local files
 .dynamodb/
+
+.vscode/

__tests__/comment.test.ts

@@ -4,17 +4,18 @@ import {
   updateComment
 } from "../src/comment";
 const repo = {};
-const body = "some message";
 it("findPreviousComment", async () => {
   const comment = {
     user: {
       login: "github-actions[bot]"
-    }
+    },
+    body: "<!-- Sticky Pull Request Comment -->\nprevious message"
   };
   const otherComment = {
     user: {
       login: "some-user"
-    }
+    },
+    body: "lgtm"
   };
   const octokit = {
     issues: {
@@ -35,10 +36,12 @@ it("updateComment", async () => {
       updateComment: jest.fn(() => Promise.resolve())
     }
   };
-  expect(await updateComment(octokit, repo, 456, body)).toBeUndefined();
+  expect(
+    await updateComment(octokit, repo, 456, "hello there")
+  ).toBeUndefined();
   expect(octokit.issues.updateComment).toBeCalledWith({
     comment_id: 456,
-    body
+    body: "<!-- Sticky Pull Request Comment -->\nhello there"
   });
 });
 it("createComment", async () => {
@@ -47,9 +50,11 @@ it("createComment", async () => {
       createComment: jest.fn(() => Promise.resolve())
     }
   };
-  expect(await createComment(octokit, repo, 456, body)).toBeUndefined();
+  expect(
+    await createComment(octokit, repo, 456, "hello there")
+  ).toBeUndefined();
   expect(octokit.issues.createComment).toBeCalledWith({
     issue_number: 456,
-    body
+    body: "<!-- Sticky Pull Request Comment -->\nhello there"
   });
 });

lib/comment.js

@@ -0,0 +1,31 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const HEADER = "<!-- Sticky Pull Request Comment -->";
+function findPreviousComment(octokit, repo, issue_number) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { data: comments } = yield octokit.issues.listComments(Object.assign(Object.assign({}, repo), { issue_number }));
+        return comments.find(comment => comment.body.startsWith(HEADER));
+    });
+}
+exports.findPreviousComment = findPreviousComment;
+function updateComment(octokit, repo, comment_id, body) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield octokit.issues.updateComment(Object.assign(Object.assign({}, repo), { comment_id, body: `${HEADER}\n${body}` }));
+    });
+}
+exports.updateComment = updateComment;
+function createComment(octokit, repo, issue_number, body) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield octokit.issues.createComment(Object.assign(Object.assign({}, repo), { issue_number, body: `${HEADER}\n${body}` }));
+    });
+}
+exports.createComment = createComment;

lib/main.js

@@ -18,31 +18,30 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const core = __importStar(require("@actions/core"));
 const github_1 = require("@actions/github");
+const comment_1 = require("./comment");
 function run() {
     var _a, _b, _c;
     return __awaiter(this, void 0, void 0, function* () {
         try {
             const repo = github_1.context.repo;
-            const issue_number = (_c = (_b = (_a = github_1.context) === null || _a === void 0 ? void 0 : _a.payload) === null || _b === void 0 ? void 0 : _b.pull_request) === null || _c === void 0 ? void 0 : _c.number;
-            if (!issue_number) {
+            const number = (_c = (_b = (_a = github_1.context) === null || _a === void 0 ? void 0 : _a.payload) === null || _b === void 0 ? void 0 : _b.pull_request) === null || _c === void 0 ? void 0 : _c.number;
+            const body = core.getInput("message");
+            const githubToken = core.getInput("GITHUB_TOKEN");
+            if (!number) {
                 core.setFailed("This action only works for pull_request");
                 return;
             }
-            const body = core.getInput("message");
-            const githubToken = core.getInput("GITHUB_TOKEN");
             if (!body || !githubToken) {
                 core.setFailed("invalid input: please check your workflow");
                 return;
             }
             const octokit = new github_1.GitHub(githubToken);
-            const { data: comments } = yield octokit.issues.listComments(Object.assign(Object.assign({}, repo), { issue_number }));
-            const myComment = comments.find(comment => comment.user.login === "github-actions[bot]");
-            if (myComment) {
-                yield octokit.issues.updateComment(Object.assign(Object.assign({}, repo), { comment_id: myComment.id, body }));
+            const previous = yield comment_1.findPreviousComment(octokit, repo, number);
+            if (previous) {
+                yield comment_1.updateComment(octokit, repo, previous.id, body);
             }
             else {
-                yield octokit.issues.createComment(Object.assign(Object.assign({}, repo), { issue_number,
-                    body }));
+                yield comment_1.createComment(octokit, repo, number, body);
             }
         }
         catch ({ message }) {

src/comment.ts

@@ -1,21 +1,23 @@
+const HEADER = "<!-- Sticky Pull Request Comment -->";
+
 export async function findPreviousComment(octokit, repo, issue_number) {
   const { data: comments } = await octokit.issues.listComments({
     ...repo,
     issue_number
   });
-  return comments.find(comment => comment.user.login === "github-actions[bot]");
+  return comments.find(comment => comment.body.startsWith(HEADER));
 }
 export async function updateComment(octokit, repo, comment_id, body) {
   await octokit.issues.updateComment({
     ...repo,
     comment_id,
-    body
+    body: `${HEADER}\n${body}`
   });
 }
 export async function createComment(octokit, repo, issue_number, body) {
   await octokit.issues.createComment({
     ...repo,
     issue_number,
-    body
+    body: `${HEADER}\n${body}`
   });
 }