v2.10.0: Support NONE option on publish-as config.

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [2.10.0] - 2023-07-11
+### Added
+- `publish-as` config now supports the `NONE` option to prevent publishing the stats in the pull request.
+
 ## [2.9.0] - 2023-06-03
 ### Added
 - [#70](https://github.com/flowwer-dev/pull-request-stats/pull/70) Removes `-review:none` filter. Let PRs with requested changes be included in the stats (By [Danny McCormick](https://github.com/damccorm)).

README.md

@@ -53,7 +53,7 @@ The possible inputs for this action are:
 | `charts` | Whether to add a chart to the start. Possible values: `true` or `false`. | `false` |
 | `disable-links` | If `true`, removes the links to the detailed charts. Possible values: `true` or `false`. | `false` |
 | `sort-by` | The column used to sort the data. Possible values: `REVIEWS`, `TIME`, `COMMENTS`. | `REVIEWS` |
-| `publish-as` | Where to publish the results. Possible values: as a `COMMENT`, on the pull request `DESCRIPTION`. | `COMMENT` |
+| `publish-as` | Where to publish the results. Possible values: as a `COMMENT`, on the pull request `DESCRIPTION`, or publish `NONE`. | `COMMENT` |
 | `telemetry` | Indicates if the action is allowed to send monitoring data to the developer. This data is [minimal](/src/services/telemetry/sendStart.js) and helps me improve this action. **This option is a premium feature reserved for [sponsors](#premium-features-).** |`true`|
 | `slack-webhook` | **🔥 New.** A Slack webhook URL to post resulting stats. **This option is a premium feature reserved for [sponsors](#premium-features-).** See [full documentation here](/docs/slack.md).  |`null`|
 | `slack-channel` | The Slack channel where stats will be posted. Include the `#` character (eg. `#mychannel`). Required when a `slack-webhook` is configured. |`null`|

action.yml

@@ -32,7 +32,7 @@ inputs:
     required: false
     default: 'REVIEWS'
   publish-as:
-    description: 'Where to publish the results. Possible values: "COMMENT" or "DESCRIPTION"'
+    description: 'Where to publish the results. Possible values: "COMMENT", "DESCRIPTION" or "NONE"'
     required: false
     default: 'COMMENT'
   disable-links:

dist/index.js

@@ -2469,6 +2469,8 @@ module.exports = ({
   currentBody,
   pullRequestId,
 }) => {
+  if (publishAs === 'NONE') return null;
+
   if (publishAs === 'DESCRIPTION') {
     return updatePullRequest({
       octokit,
@@ -15458,7 +15460,7 @@ module.exports = function bind(fn, thisArg) {
 /***/ 731:
 /***/ (function(module) {
 
-module.exports = {"name":"pull-request-stats","version":"2.9.0","description":"Github action to print relevant stats about Pull Request reviewers","main":"dist/index.js","scripts":{"build":"eslint src && ncc build src/index.js","test":"jest","lint":"eslint ./"},"keywords":[],"author":"Manuel de la Torre","license":"MIT","jest":{"testEnvironment":"node","testMatch":["**/?(*.)+(spec|test).[jt]s?(x)"]},"dependencies":{"@actions/core":"^1.5.0","@actions/github":"^5.0.0","axios":"^0.26.1","humanize-duration":"^3.27.0","i18n-js":"^3.9.2","jsurl":"^0.1.5","lodash.get":"^4.4.2","markdown-table":"^2.0.0","mixpanel":"^0.13.0"},"devDependencies":{"@zeit/ncc":"^0.22.3","eslint":"^7.32.0","eslint-config-airbnb-base":"^14.2.1","eslint-plugin-import":"^2.24.1","eslint-plugin-jest":"^24.4.0","jest":"^27.0.6"},"funding":"https://github.com/sponsors/manuelmhtr"};
+module.exports = {"name":"pull-request-stats","version":"2.10.0","description":"Github action to print relevant stats about Pull Request reviewers","main":"dist/index.js","scripts":{"build":"eslint src && ncc build src/index.js","test":"jest","lint":"eslint ./"},"keywords":[],"author":"Manuel de la Torre","license":"MIT","jest":{"testEnvironment":"node","testMatch":["**/?(*.)+(spec|test).[jt]s?(x)"]},"dependencies":{"@actions/core":"^1.5.0","@actions/github":"^5.0.0","axios":"^0.26.1","humanize-duration":"^3.27.0","i18n-js":"^3.9.2","jsurl":"^0.1.5","lodash.get":"^4.4.2","markdown-table":"^2.0.0","mixpanel":"^0.13.0"},"devDependencies":{"@zeit/ncc":"^0.22.3","eslint":"^7.32.0","eslint-config-airbnb-base":"^14.2.1","eslint-plugin-import":"^2.24.1","eslint-plugin-jest":"^24.4.0","jest":"^27.0.6"},"funding":"https://github.com/sponsors/manuelmhtr"};
 
 /***/ }),
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pull-request-stats",
-  "version": "2.9.0",
+  "version": "2.10.0",
   "description": "Github action to print relevant stats about Pull Request reviewers",
   "main": "dist/index.js",
   "scripts": {

src/interactors/__tests__/postComment.test.js

@@ -43,4 +43,11 @@ describe('Interactors | .postComment', () => {
       body: content,
     });
   });
+
+  it('does nothing when publishAs is "NONE"', async () => {
+    const publishAs = 'NONE';
+    await postComment({ ...baseParams, publishAs });
+    expect(commentOnPullRequest).not.toBeCalled();
+    expect(updatePullRequest).not.toBeCalled();
+  });
 });

src/interactors/postComment.js

@@ -12,6 +12,8 @@ module.exports = ({
   currentBody,
   pullRequestId,
 }) => {
+  if (publishAs === 'NONE') return null;
+
   if (publishAs === 'DESCRIPTION') {
     return updatePullRequest({
       octokit,