Add skipComment input

Author: matejchalk

README.md

@@ -67,6 +67,7 @@ The action may be customized using the following optional inputs:
 | `token`            | GitHub token for authorizing GitHub API requests                                  | `${{ github.token }}`                                                                                  |
 | `annotations`      | Toggles if annotations should be created for relevant Code PushUp issues          | `true`                                                                                                 |
 | `artifacts`        | Toggles if artifacts will we uploaded/downloaded                                  | `true`                                                                                                 |
+| `skipComment`      | Toggles if comparison comment is posted to PR                                     | `false`                                                                                                |
 | `retention`        | Artifact retention period in days                                                 | from repository settings                                                                               |
 | `directory`        | Directory in which `code-pushup` should run                                       | `process.cwd()`                                                                                        |
 | `config`           | Path to config file (`--config` option)                                           | see [`@code-pushup/cli` docs](https://github.com/code-pushup/cli/tree/main/packages/cli#configuration) |

__tests__/main.test.ts

@@ -1,8 +1,8 @@
 import type { ArtifactClient } from '@actions/artifact'
 import core from '@actions/core'
 import github from '@actions/github'
-import { jest } from '@jest/globals'
 import type { Report } from '@code-pushup/models'
+import { jest } from '@jest/globals'
 import type { components } from '@octokit/openapi-types'
 import type { RestEndpointMethodTypes } from '@octokit/plugin-rest-endpoint-methods'
 import {
@@ -72,6 +72,7 @@ describe('code-pushup action', () => {
     process.env['INPUT_SILENT'] = 'true'
     process.env['INPUT_ARTIFACTS'] = 'true'
     process.env['INPUT_ANNOTATIONS'] = 'true'
+    process.env['INPUT_SKIPCOMMENT'] = 'false'
 
     jest.spyOn(github.context, 'repo', 'get').mockReturnValue({
       owner: 'dunder-mifflin',

action.yml

@@ -76,6 +76,10 @@ inputs:
     description: Create file annotations in GitHub
     required: true
     default: true
+  skipComment:
+    description: Skip PR comment
+    required: true
+    default: false
 
 outputs:
   artifact-id:

dist/index.js

@@ -19,6 +19,7 @@ export type ActionInputs = {
   artifacts: boolean
   retention: number | null
   annotations: boolean
+  skipComment: boolean
 }
 
 export function parseInputs(): ActionInputs {
@@ -35,6 +36,7 @@ export function parseInputs(): ActionInputs {
   const artifacts = core.getBooleanInput('artifacts')
   const retention = parseInteger(core.getInput('retention'))
   const annotations = core.getBooleanInput('annotations')
+  const skipComment = core.getBooleanInput('skipComment')
 
   return {
     monorepo,
@@ -49,7 +51,8 @@ export function parseInputs(): ActionInputs {
     silent,
     artifacts,
     retention,
-    annotations
+    annotations,
+    skipComment
   }
 }
 

dist/index.js.map

@@ -13,6 +13,7 @@ export function createOptions(inputs: ActionInputs): Required<Options> {
     bin: inputs.bin,
     config: inputs.config,
     detectNewIssues: inputs.annotations,
+    skipComment: inputs.skipComment,
     silent: inputs.silent,
     debug: core.isDebug(),
     logger: {