Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow to filter runners via config #371

Merged
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add short properties description
  • Loading branch information
povilasjurcys committed Mar 23, 2021
commit a060c2e7b1b0f6b74daa2ca2b58f6a915184a719
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ in order to avoid the rate limit of the providers.
X = N / {PRONTO_WARNINGS_PER_REVIEW || warnings_per_review || 30})
```

Note: In case no environment variable or config setting is specified in `.pronto.yml`,
Note: In case no environment variable or config setting is specified in `.pronto.yml`,
a default value of `30` will be used.

```sh
Expand Down Expand Up @@ -164,7 +164,7 @@ Pronto.run('origin/master', '.', formatters)

#### GitHub Actions Integration

You can also run Pronto as a GitHub action.
You can also run Pronto as a GitHub action.

Here's an example `.github/workflows/pronto.yml` workflow file using the `github_status` and `github_pr` formatters and running on each GitHub PR, with `pronto-rubocop` as the runner:

Expand Down Expand Up @@ -299,6 +299,14 @@ via environment variables. Their names will be the upcased path to the property.
For example: `PRONTO_GITHUB_SLUG` or `PRONTO_GITLAB_API_PRIVATE_TOKEN`. Environment variables
will always take precedence over values in configuration file.

| Property | Description |
|-----------------------|--------------------------------------------------------------------------------------|
| `max_warnings` | Limits the amount of warnings. Returns all warnings if option is skipped. |
| `runners` | Runs only listed runners. Runs everything if option is skipped. |
| `skip_runners` | All, except listed runners will be executed. Runs everything if option is skipped. |
| `verbose` | Outputs more information when set to `true`. |
| `warnings_per_review` | Limits the amount of warnings per review. Returns all warnings if option is skipped. |

### Message format

Pronto allows you to configure the format of the messages that are produced. You
Expand Down