Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
julioprotzek committed Jun 8, 2024
1 parent 262af70 commit 6e06c63
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 4 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# GitHub Action: Run standardrb with reviewdog 🐶
# GitHub Action: Run Standard Ruby and Standard Rails with reviewdog 🐶

This action runs [standardrb](https://github.com/testdouble/standard) with
[reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to improve
Expand All @@ -8,7 +8,9 @@ code review experience.

```yml
name: Lint

on: pull_request

jobs:
standardrb:
name: Standard Ruby
Expand All @@ -20,11 +22,13 @@ jobs:
uses: smile-io/action-standardrb@master
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review # Default is github-pr-check
rubocop_flags: --format progress
standard_version: 1.36.0
standard_rails_version: 1.0.2
```
## Examples
<img src="./examples/github-pr-review.png" alt="Screenshot with reviewdog comments for Standard Ruby lint errors">
## License
[MIT](https://choosealicense.com/licenses/mit)
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ inputs:
default: "error"
reporter:
description: |
Reporter of reviewdog command [github-pr-check,github-pr-review].
Reporter of reviewdog command [github-pr-review,github-pr-check].
Default is github-pr-review.
default: "github-pr-review"
standard_version:
Expand Down
Binary file removed examples/example-github-pr-check.png
Binary file not shown.
Binary file removed examples/example-github-pr-review.png
Binary file not shown.
Binary file added examples/github-pr-review.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6e06c63

Please sign in to comment.