-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement fail_on_error feature for github-pr-review reporter (#21)
* Implement fail_on_error feature for github-pr-review reporter * Enable fail_on_error by default * Provide fail_on_error arg to container * Update action version
- Loading branch information
Showing
3 changed files
with
25 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,42 +24,48 @@ This action has several inputs you may be interested in: | |
|
||
### `github_token` | ||
|
||
**Required.** Must be in form of github_token: ${{ secrets.github_token }}. | ||
**Required.** Must be in form of `github_token: ${{ secrets.github_token }}`. | ||
|
||
### `reviewdog_level` | ||
|
||
Optional. Report level for reviewdog's `github-pr-check` reporter [`info`,`warning`,`error`]. | ||
Optional. Report level for reviewdog's `github-pr-check` reporter [`info`,`warning`,`error`]. | ||
It's same as `-level` flag of reviewdog. | ||
The default is `error`. | ||
|
||
### `reviewdog_filter` | ||
|
||
Optional. Filter mode for reviewdog. [`added `,`diff_context`,`file`,`nofilter`] | ||
It's same as `-filter-mode` flag of reviewdog. | ||
Optional. Filter mode for reviewdog. [`added `,`diff_context`,`file`,`nofilter`] | ||
It's same as `-filter-mode` flag of reviewdog. | ||
The default is `added`. | ||
|
||
[Read more](https://github.com/reviewdog/reviewdog#filter-mode) | ||
|
||
### `reviewdog_reporter` | ||
|
||
Optional. Reporter for reviewdog. [`github-pr-check`,`github-pr-review`] | ||
Optional. Reporter for reviewdog. [`github-pr-check`,`github-pr-review`] | ||
The default is `github-pr-check`. | ||
|
||
[Read more](https://github.com/reviewdog/reviewdog#reporters) | ||
|
||
### `detekt_config` | ||
|
||
Optional. Path to the config file for detekt. The default is `default-detekt-config.yml` | ||
Optional. Path to the config file for detekt. | ||
The default is `default-detekt-config.yml` | ||
|
||
[Read more](https://detekt.github.io/detekt/cli.html) | ||
|
||
### `detekt_excludes` | ||
|
||
Optional. Globing patterns describing paths to exclude from the analysis. | ||
Optional. Globing patterns describing paths to exclude from the analysis. | ||
The default is `**/build/**,**/.idea/**` | ||
|
||
[Read more](https://detekt.github.io/detekt/cli.html) | ||
|
||
### `fail_on_error` | ||
|
||
Optional. Fails the current check if any error was found [`true`/`false`] | ||
The default value is `true`. | ||
|
||
## Usage | ||
|
||
Following example runs detekt with | ||
|
@@ -81,7 +87,7 @@ jobs: | |
ref: ${{ github.head_ref }} | ||
|
||
- name: detekt | ||
uses: alaegin/[email protected] | ||
uses: DominuS-RU/[email protected].1 | ||
with: | ||
github_token: ${{ secrets.github_token }} | ||
detekt_config: detekt-config.yml # Change config path | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters