Skip to content

Commit

Permalink
fix(readme): corrected example
Browse files Browse the repository at this point in the history
  • Loading branch information
Shemnei committed Jan 20, 2024
2 parents 9bed3cd + 0633d2f commit 51ec14f
Showing 1 changed file with 20 additions and 23 deletions.
43 changes: 20 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,26 @@ This action runs [typos](https://github.com/crate-ci/typos) with
[reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to improve
code review experience.

## Usage

```yaml
name: Reviewdog

on: [pull_request]

jobs:
typos:
name: runner / typos
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: Shemnei/reviewdog-action-typos@v0
with:
reporter: github-check
level: error
fail_on_error: true
```

## Input

For a complete list of accepted input values see [action.yaml](./action.yaml).
Expand Down Expand Up @@ -122,26 +142,3 @@ The original `typos` action also has the following inputs which are declared but
To allow easy porting (copy-paste) and have feature parity the inputs where included but will print a deprecated warning on usage.

__NOTE__: The value of these inputs will be ignored and are not used.

## Usage

```yaml
name: reviewdog
on: [pull_request]
jobs:
typos:
name: runner / typos
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: reviewdog/action-template@v1
with:
github_token: ${{ secrets.github_token }}
# Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review].
reporter: github-pr-review
# Change reporter level if you need.
# GitHub Status Check won't become failure with warning.
level: warning
exclude: |
*.yaml
```

0 comments on commit 51ec14f

Please sign in to comment.