Skip to content

Commit

Permalink
šŸ“ docs(actions): Sync input section of action.yml with that of `Rā€¦
Browse files Browse the repository at this point in the history
ā€¦EADME.md`
  • Loading branch information
blooper05 committed Jun 8, 2022
1 parent d3f747d commit 4f6e076
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,39 +21,40 @@ code review experience.
```yaml
inputs:
github_token:
description: 'GITHUB_TOKEN'
default: '${{ github.token }}'
description: GITHUB_TOKEN
default: ${{ github.token }}
workdir:
description: 'Working directory relative to the root directory.'
default: '.'
description: Working directory relative to the root directory.
default: .
### Flags for reviewdog ###
tool_name:
description: 'Tool name to use for reviewdog reporter'
default: 'rails_best_practices'
description: Tool name to use for reviewdog reporter
default: rails_best_practices
level:
description: 'Report level for reviewdog [info,warning,error]'
default: 'error'
description: Report level for reviewdog [info,warning,error]
default: error
reporter:
description: 'Reporter of reviewdog command [github-check,github-pr-review,github-pr-check].'
default: 'github-check'
description: Reporter of reviewdog command [github-check,github-pr-review,github-pr-check].
default: github-check
filter_mode:
description: |
Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
Default is added.
default: 'added'
default: added
fail_on_error:
description: |
Exit code for reviewdog when errors are found [true,false]
Default is `false`.
default: 'false'
reviewdog_flags:
description: 'Additional reviewdog flags'
description: Additional reviewdog flags
default: ''
### Flags for rails_best_practices ###
rails_best_practices_version:
description: 'rails_best_practices version'
description: rails_best_practices version
rails_best_practices_flags:
description: 'rails_best_practices flags (rails_best_practices --without-color --silent . <rails_best_practices_flags>)'
description: |
rails_best_practices flags (rails_best_practices --without-color --silent . <rails_best_practices_flags>)
default: ''
```
Expand Down

0 comments on commit 4f6e076

Please sign in to comment.