Skip to content

Commit ceb4fd3

Browse files
chore: format input args
1 parent 3c6e507 commit ceb4fd3

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,19 +45,19 @@ To integrate with this Github Action, you can just use the following configurati
4545
4646
## Inputs
4747
48-
| Key | Required | Default | Description |
49-
| ---------------------------- | -------- | --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
50-
| `github-token` | **yes** | - | Default Github Actions token. The token is not required if GitHub application is installed and the token passed through `barecheck-github-app-token` |
51-
| `lcov-file` | **yes** | - | Lcov.info file that was generated after your test coverage command |
52-
| `barecheck-github-app-token` | **no** | - | Barecheck application token, received after application installation comment. |
53-
| `barecheck-api-key` | **no** | - | Your project API_KEY generated from https://barecheck.com. Use this property to avoid running coverage for the base branch. |
54-
| `base-lcov-file` | **no** | - | Lcov.info file that would be used to compare code coverage. The comparison will be disabled if the file is not passed |
55-
| `send-summary-comment` | **no** | true | Option to send Github code coverage comment based on the changes that were made in PR |
56-
| `show-annotations` | **no** | 'warning' | Option to enable Github annotation that would show uncovered files in review tab. Options: ' ' \| warning \| error |
57-
| `minimum-ratio` | **no** | '' | Percentage of uncovered lines that are allowed for new changes |
58-
| `app-name` | **no** | 'Barecheck' | Application name would be used once you have more than one report in your workflow and want to have different reports per application. |
59-
| `workspace-path` | **no** | 'Barecheck' | Option to specify the path of projects in monorepo |
60-
| `pull-number` | **no** | 'Pull request number (Optional). For use in non-'pull_request' events |
48+
| Key | Required | Default | Description |
49+
| ---------------------------- | -------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
50+
| `github-token` | **yes** | - | Default Github Actions token. The token is not required if GitHub application is installed and the token passed through `barecheck-github-app-token` |
51+
| `lcov-file` | **yes** | - | Lcov.info file that was generated after your test coverage command |
52+
| `barecheck-github-app-token` | **no** | - | Barecheck application token, received after application installation comment. |
53+
| `barecheck-api-key` | **no** | - | Your project API_KEY generated from https://barecheck.com. Use this property to avoid running coverage for the base branch. |
54+
| `base-lcov-file` | **no** | - | Lcov.info file that would be used to compare code coverage. The comparison will be disabled if the file is not passed |
55+
| `send-summary-comment` | **no** | true | Option to send Github code coverage comment based on the changes that were made in PR |
56+
| `show-annotations` | **no** | 'warning' | Option to enable Github annotation that would show uncovered files in review tab. Options: ' ' \| warning \| error |
57+
| `minimum-ratio` | **no** | '' | Percentage of uncovered lines that are allowed for new changes |
58+
| `app-name` | **no** | 'Barecheck' | Application name would be used once you have more than one report in your workflow and want to have different reports per application. |
59+
| `workspace-path` | **no** | 'Barecheck' | Option to specify the path of projects in monorepo |
60+
| `pull-number` | **no** | '' | Pull request number (Optional). For use in non-'pull_request' events |
6161

6262
## Workflow Example
6363

0 commit comments

Comments
 (0)