Skip to content

Commit

Permalink
Fixed README docs
Browse files Browse the repository at this point in the history
  • Loading branch information
prologic committed Jan 25, 2020
1 parent 9f44326 commit 5686805
Showing 1 changed file with 2 additions and 20 deletions.
22 changes: 2 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,7 @@ Reporter of reviewdog command [github-pr-check,github-pr-review,github-check].
Default is github-pr-check.
github-pr-review can use Markdown and add a link to rule page in reviewdog reports.

### `path`

Optional. Base directory to run remark-lint. Same as `[path]` of `find` command. Default: `.`

### `pattern`

Optional. File patterns of target files. Same as `-name [pattern]` of `find` command. Default: `*.sh`

### `exclude`

Optional. Exclude patterns of target files. Same as `-not -path [exclude]` of `find` command.
e.g. `./git/*`

### `remark-lint_flags`

Optional. Flags of remark-lint command. Default: ``
**NB:** Only `github-pr-check` is supported currently.

## Example usage

Expand All @@ -60,8 +45,5 @@ jobs:
uses: prologic/action-remark-lint@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
reporter: github-pr-review # Change reporter.
path: "." # Optional.
pattern: "*.sh" # Optional.
exclude: "./.git/*" # Optional.
reporter: github-pr-review # Change reporter. (Only `github-pr-check` is supported at the moment).
```

0 comments on commit 5686805

Please sign in to comment.