Add comment input to allow/prevent version check comments

Author: ncalteen

README.md

@@ -112,6 +112,7 @@ version is updated when new features are released.
 | ------------------ | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
 | `allow-prerelease` | `'true'`                  | If `check-only` is `'true'`, this controls if the check should pass if a matching prerelease version is detected (e.g. `v1.0.0-SNAPSHOT`). |
 | `check-only`       | `'false'`                 | If set to `'true'`, only checks if the version exists. Fails the action if the version already exists.                                     |
+| `comment`          | `'true'`                  | If set to `'true'`, a comment will be added to the pull request indicating if the version is valid or conflicts with an existing version.  |
 | `manifest-path`    |                           | The path to the manifest that contains the version (relative to the root of the repository).                                               |
 |                    |                           | If not set, `use-version` must be set.                                                                                                     |
 | `overwrite`        | `'false'`                 | Set to `'true'` to overwrite existing tags.                                                                                                |

action.yml

@@ -18,6 +18,12 @@ inputs:
       If set to 'true', the action will only check if the version exists and, if
       so, will fail. Defaults to 'false'.
     required: false
+  comment:
+    default: 'true'
+    description:
+      If set to 'true', the action will comment on the pull request indicating
+      if the version is valid. Defaults to 'true'.
+    required: false
   manifest-path:
     description:
       The path to the manifest file that contains the version information,

dist/index.js

@@ -1,7 +1,7 @@
 {
   "name": "issue-ops-semver",
   "description": "Semantically version GitHub repository tags",
-  "version": "2.3.2",
+  "version": "2.4.0",
   "type": "module",
   "author": "Nick Alteen <ncalteen@github.com>",
   "homepage": "https://github.com/issue-ops/semver#readme",

dist/index.js.map

@@ -12,6 +12,7 @@ export async function run() {
   const useVersion: string = core.getInput('use-version')
   const workspace: string = core.getInput('workspace')
   const push: boolean = core.getInput('push-tags') === 'true'
+  const comment: boolean = core.getInput('comment') === 'true'
 
   if (
     (manifestPath === '' && useVersion === '') ||
@@ -46,7 +47,8 @@ export async function run() {
   if (
     github.context.issue?.number !== undefined &&
     github.context.eventName === 'pull_request' &&
-    github.context.payload?.action !== 'closed'
+    github.context.payload?.action !== 'closed' &&
+    comment
   )
     await versionCheckComment(!exists, manifestPath)