Hide comment (#19)

* eslint update * add hide comment * update readme & version
MishaKav · Jul 26, 2021 · 21fd3ae · 21fd3ae
1 parent 2cb7a17
commit 21fd3ae
Show file tree

Hide file tree

Showing 9 changed files with 71 additions and 59 deletions.
diff --git a/.github/workflows/live-test.yml b/.github/workflows/live-test.yml
@@ -10,7 +10,7 @@ jobs:
 
       - name: Pytest coverage comment
         id: coverageComment
-        uses: MishaKav/[email protected].5
+        uses: MishaKav/[email protected].6
         with:
           pytest-coverage-path: ./data/pytest-coverage_4.txt
           junitxml-path: ./data/pytest_1.xml

diff --git a/.github/workflows/multiple-files.yml b/.github/workflows/multiple-files.yml
@@ -8,7 +8,7 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Pytest coverage comment
-        uses: MishaKav/[email protected].5
+        uses: MishaKav/[email protected].6
         with:
           multiple-files: |
             My Title 1, ./data/pytest-coverage_3.txt, ./data/pytest_1.xml

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ You can add this action to your GitHub workflow for Ubuntu runners (e.g. runs-on
 
 ```yaml
 - name: Pytest coverage comment
-  uses: MishaKav/[email protected].5
+  uses: MishaKav/[email protected].6
   with:
     pytest-coverage-path: ./pytest-coverage.txt
     junitxml-path: ./pytest.xml
@@ -27,6 +27,7 @@ You can add this action to your GitHub workflow for Ubuntu runners (e.g. runs-on
 | `junitxml-path`        |          | ''                      | The location of the junitxml path                                                                                                                                                                                                                                                                                                                                             |
 | `junitxml-title`       |          | ''                      | Title for summary for junitxml                                                                                                                                                                                                                                                                                                                                                |
 | `create-new-comment`   |          | false                   | When false, will update the same comment, otherwise will publish new comment on each run.                                                                                                                                                                                                                                                                                     |
+| `hide-comment`         |          | false                   | Hide the whole comment (use when you need only the `output`). Useful for auto-update bagdes in readme. See the [workflow](../main/.github/workflows/main.yml) for example                                                                                                                                                                                                    |
 | `multiple-files`       |          | ''                      | You can pass array of titles and files to generate single comment with table of results.<br/>Single line should look like `Title, ./path/to/pytest-coverage.txt, ./path/to/pytest.xml`<br/> example:<br/> `My Title 1, ./data/pytest-coverage_3.txt, ./data/pytest_1.xml`<br/>**Note:** In that mode the `output` for `coverage` and `color` will be for the first file only. |
 
 ## Output example
@@ -71,7 +72,7 @@ jobs:
           pytest --junitxml=pytest.xml --cov=app tests/ | tee pytest-coverage.txt
 
       - name: Pytest coverage comment
-        uses: MishaKav/[email protected].5
+        uses: MishaKav/[email protected].6
         with:
           pytest-coverage-path: ./pytest-coverage.txt
           junitxml-path: ./pytest.xml
@@ -82,7 +83,7 @@ Example GitHub Action workflow that uses coverage percentage as output (see the
 ```yaml
 - name: Pytest coverage comment
   id: coverageComment
-  uses: MishaKav/[email protected].5
+  uses: MishaKav/[email protected].6
   with:
     pytest-coverage-path: ./pytest-coverage.txt
     junitxml-path: ./pytest.xml
@@ -97,14 +98,15 @@ Example GitHub Action workflow that passes all params to Pytest Coverage Comment
 
 ```yaml
 - name: Pytest coverage comment
-  uses: MishaKav/[email protected].5
+  uses: MishaKav/[email protected].6
   with:
     pytest-coverage-path: ./path-to-file/pytest-coverage.txt
     title: My Coverage Report Title
     badge-title: My Badge Coverage Title
     hide-badge: false
     hide-report: false
     create-new-comment: false
+    hide-comment: false
     junitxml-path: ./path-to-file/pytest.xml
     junitxml-title: My JUnit Xml Summary Title
 ```
@@ -120,7 +122,7 @@ It will generate `pytest-coverage.txt` and `pytest.xml` in `/tmp` directory insi
     docker run -v /tmp:/tmp $IMAGE_TAG python3 -m pytest --cov-report=term-missing:skip-covered --junitxml=/tmp/pytest.xml --cov=src tests/ | tee /tmp/pytest-coverage.txt
 
 - name: Pytest coverage comment
-  uses: MishaKav/[email protected].5
+  uses: MishaKav/[email protected].6
   with:
     pytest-coverage-path: /tmp/pytest-coverage.txt
     junitxml-path: /tmp/pytest.xml
@@ -130,7 +132,7 @@ Example GitHub Action workflow that uses multiple files mode (see the [live work
 
 ```yaml
 - name: Pytest coverage comment
-  uses: MishaKav/[email protected].5
+  uses: MishaKav/[email protected].6
   with:
     multiple-files: |
       My Title 1, ./data/pytest-coverage_3.txt, ./data/pytest_1.xml

diff --git a/action.yml b/action.yml
@@ -29,6 +29,10 @@ inputs:
     description: 'Hide coverage report'
     default: 'false'
     required: false
+  hide-comment:
+    description: 'Hide the whole comment (use when you need only `output`)'
+    default: 'false'
+    required: false
   junitxml-path:
     description: 'The location of the junitxml path'
     default: ''

diff --git a/dist/index.js b/dist/index.js
@@ -13278,6 +13278,7 @@ const main = async () => {
   const createNewComment = core.getBooleanInput('create-new-comment', {
     required: false,
   });
+  const hideComment = core.getBooleanInput('hide-comment', { required: false });
   const covFile = core.getInput('pytest-coverage-path', { required: false });
   const xmlFile = core.getInput('junitxml-path', { required: false });
   const xmlTitle = core.getInput('junitxml-title', { required: false });
@@ -13299,6 +13300,7 @@ const main = async () => {
     hideBadge,
     hideReport,
     createNewComment,
+    hideComment,
     xmlTitle,
     multipleFiles,
   };
@@ -13342,7 +13344,7 @@ const main = async () => {
     }
   }
 
-  if (!finalHtml) {
+  if (!finalHtml || options.hideComment) {
     console.log('Nothing to report');
     return;
   }

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pytest-coverage-comment",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "Comments a pull request with the pytest code coverage badge, full report and tests summary",
   "author": "Misha Kav",
   "license": "MIT",
@@ -29,7 +29,7 @@
   },
   "devDependencies": {
     "@vercel/ncc": "^0.29.0",
-    "eslint": "^7.30.0",
+    "eslint": "^7.31.0",
     "prettier": "^2.3.2"
   },
   "prettier": {

diff --git a/src/cli.js b/src/cli.js
@@ -54,6 +54,7 @@ const main = async () => {
     hideBadge: false,
     hideReport: true,
     createNewComment: false,
+    hideComment: false,
     xmlTitle: '',
     multipleFiles,
   };
@@ -68,7 +69,7 @@ const main = async () => {
     finalHtml += finalHtml.length ? `\n\n${summaryReport}` : summaryReport;
   }
 
-  if (!finalHtml) {
+  if (!finalHtml || options.hideComment) {
     console.log('Nothing to report');
     return;
   }

diff --git a/src/index.js b/src/index.js
@@ -15,6 +15,7 @@ const main = async () => {
   const createNewComment = core.getBooleanInput('create-new-comment', {
     required: false,
   });
+  const hideComment = core.getBooleanInput('hide-comment', { required: false });
   const covFile = core.getInput('pytest-coverage-path', { required: false });
   const xmlFile = core.getInput('junitxml-path', { required: false });
   const xmlTitle = core.getInput('junitxml-title', { required: false });
@@ -36,6 +37,7 @@ const main = async () => {
     hideBadge,
     hideReport,
     createNewComment,
+    hideComment,
     xmlTitle,
     multipleFiles,
   };
@@ -79,7 +81,7 @@ const main = async () => {
     }
   }
 
-  if (!finalHtml) {
+  if (!finalHtml || options.hideComment) {
     console.log('Nothing to report');
     return;
   }