chore: add mode to readme

hokify · Feb 22, 2023 · 88d2c61 · 88d2c61
1 parent be11439
commit 88d2c61
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -29,6 +29,7 @@ The possible inputs for this action are:
 | `monorepo-base-path` (**Required**) | The location of your monrepo `packages` path                                                                                                                                 |         |
 | `s3-config`                         | Configuration for uploading lcov files to s3. Json Encoded. e.g. '{ credentials: { accessKeyId: "", secretAccessKey: "" }, region: "", Bucket: "repository-code-coverage" }' |         |
 | `threshold`                         | Sets the threshold before the action fails if coverage of a package decreases                                                                                                | 0.05%   |
+| `mode`                              | collect: upload lcov files to s3, report: generate report, merge: set new base                                                                                               | (auto)  |
 
 ## Examples
 

diff --git a/action.yml b/action.yml
@@ -18,7 +18,7 @@ inputs:
         description: 'minimum threshold (in %) before the action fails, default is 0.05%'
         required: false
     mode:
-      description: 'overwrite mode manually: merge (on merge) | generate (upload tmp files)  | report (generate report), if not specified it combiens generate and report in one step'
+      description: 'overwrite mode manually: collect (upload tmp files)  | report (generate report) | merge (on merge)'
       required: false
 runs:
     using: node16