Skip to content

Commit f2ee672

Browse files
authored
Merge pull request #180 from reviewdog/update-examples-in-readme
Update examples in readme
2 parents c4ee0e2 + 57d0383 commit f2ee672

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,25 +21,25 @@ code review experience.
2121

2222
### `level`
2323

24-
Optional. Report level for reviewdog [info,warning,error].
24+
Optional. Report level for reviewdog \[`info`,`warning`,`error`\].
2525
It's same as `-level` flag of reviewdog.
2626

2727
### `reporter`
2828

29-
Reporter of reviewdog command [github-pr-check,github-check,github-pr-review].
30-
Default is github-pr-review.
29+
Reporter of reviewdog command \[`github-pr-check`,`github-check`,`github-pr-review`\].
30+
Default is `github-pr-review`.
3131
It's same as `-reporter` flag of reviewdog.
3232

33-
github-pr-review can use Markdown and add a link to rule page in reviewdog reports.
33+
`github-pr-review` can use Markdown and add a link to rule page in reviewdog reports.
3434

3535
### `filter_mode`
3636

37-
Optional. Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
37+
Optional. Filtering mode for the reviewdog command \[`added`,`diff_context`,`file`,`nofilter`\].
3838
Default is added.
3939

4040
### `fail_on_error`
4141

42-
Optional. Exit code for reviewdog when errors are found [true,false]
42+
Optional. Exit code for reviewdog when errors are found \[`true`,`false`\]
4343
Default is `false`.
4444

4545
### `reviewdog_flags`
@@ -82,14 +82,14 @@ jobs:
8282
runs-on: ubuntu-latest
8383
permissions:
8484
contents: read
85-
pull-requests: write
85+
pull-requests: write
8686
steps:
87-
- uses: actions/checkout@v2
87+
- uses: actions/checkout@v3
8888
- uses: reviewdog/action-eslint@v1
8989
with:
9090
github_token: ${{ secrets.GITHUB_TOKEN }}
9191
reporter: github-pr-review # Change reporter.
92-
eslint_flags: 'src/'
92+
eslint_flags: "src/"
9393
```
9494
9595
You can also set up node and eslint manually like below.
@@ -102,13 +102,13 @@ jobs:
102102
name: runner / eslint
103103
runs-on: ubuntu-latest
104104
steps:
105-
- uses: actions/checkout@v2
106-
- uses: actions/setup-node@v2
105+
- uses: actions/checkout@v3
106+
- uses: actions/setup-node@v3
107107
with:
108-
node-version: '14'
108+
node-version: "20"
109109
- run: yarn install
110110
- uses: reviewdog/action-eslint@v1
111111
with:
112112
reporter: github-check
113-
eslint_flags: 'src/'
113+
eslint_flags: "src/"
114114
```

0 commit comments

Comments
 (0)