Merge pull request #890 from WebFreak001/only_create-setting

add setting to only create, but not update comment

README.md

@@ -155,6 +155,10 @@ is explicitly passed, this problem can be solved by just removing it.
 
 **Optional** Delete a previously created comment. Use `header` to point to which comment you want to delete. Only `true` is allowed (i.e. delete this option if you don't need it).
 
+### `only_create`
+
+**Optional** Only create a new comment if there is no existing one, otherwise do nothing. Only `true` is allowed. Just skip this item when you don't need it.
+
 ### `hide`
 
 **Optional** Hide a previously created comment. Use `header` to point to which comment you want to delete. Only `true` is allowed (i.e. delete this option if you don't need it).

__tests__/config.test.ts

@@ -4,6 +4,7 @@ beforeEach(() => {
   process.env["INPUT_APPEND"] = "false"
   process.env["INPUT_RECREATE"] = "false"
   process.env["INPUT_DELETE"] = "false"
+  process.env["INPUT_ONLY_CREATE"] = "false"
   process.env["INPUT_HIDE"] = "false"
   process.env["INPUT_HIDE_AND_RECREATE"] = "false"
   process.env["INPUT_HIDE_CLASSIFY"] = "OUTDATED"
@@ -23,6 +24,7 @@ afterEach(() => {
   delete process.env["INPUT_APPEND"]
   delete process.env["INPUT_RECREATE"]
   delete process.env["INPUT_DELETE"]
+  delete process.env["INPUT_ONLY_CREATE"]
   delete process.env["INPUT_HIDE"]
   delete process.env["INPUT_HIDE_AND_RECREATE"]
   delete process.env["INPUT_HIDE_CLASSIFY"]

action.yml

@@ -18,6 +18,10 @@ inputs:
     description: "delete the previously created comment. Only `true` is allowed. Just skip this item when you don't need it."
     default: "false"
     required: false
+  only_create:
+    description: "only create a new comment if there is no existing one, otherwise do nothing. Only `true` is allowed. Just skip this item when you don't need it. This options has higher priority than hide_and_recreate, hide."
+    default: "false"
+    required: false
   hide_details:
     description: "hide summary tags in the previously created comment. Only `true` is allowed. Just skip this item when you don't need it."
     default: "false"

src/config.ts

@@ -22,6 +22,9 @@ export const hideClassify = core.getInput("hide_classify", {
   required: true
 }) as ReportedContentClassifiers
 export const deleteOldComment = core.getBooleanInput("delete", {required: true})
+export const onlyCreateComment = core.getBooleanInput("only_create", {
+  required: true
+})
 export const hideOldComment = core.getBooleanInput("hide", {required: true})
 export const githubToken = core.getInput("GITHUB_TOKEN", {required: true})
 export const ignoreEmpty = core.getBooleanInput("ignore_empty", {

src/main.ts

@@ -13,7 +13,8 @@ import {
   pullRequestNumber,
   recreate,
   repo,
-  ignoreEmpty
+  ignoreEmpty,
+  onlyCreateComment
 } from "./config"
 import {
   createComment,
@@ -70,6 +71,12 @@ async function run(): Promise<undefined> {
       return
     }
 
+    if (onlyCreateComment) {
+      // don't comment anything, user specified only_create and there is an
+      // existing comment, so this is probably a placeholder / introduction one.
+      return
+    }
+
     if (hideOldComment) {
       await minimizeComment(octokit, previous.id, hideClassify)
       return