Awesome
GitHub Action: Run misspell with reviewdog
This action runs misspell with reviewdog on pull requests to improve code review experience.
Inputs
github_token
Optional. ${{ github.token }}
is used by default.
locale
Optional. -locale flag of misspell. [US
/UK
]
level
Optional. Report level for reviewdog [info
,warning
,error
].
It's the same as the -level
flag of reviewdog.
reporter
Optional. Reporter for reviewdog command [github-pr-check
,github-pr-review
].
It's the same as the -reporter
flag of reviewdog.
ignore
Optional. Ignore (-i
) a list of comma-separated words. [armor
] / [armor,color
].
path
Optional. Base directory to run misspell. Same as [path]
of find
command. Default: .
Directories are separated by lines. e.g.:
path: |
doc
src
pattern
Optional. File patterns of target files. Same as -name [pattern]
of find
command. Default: *
Patterns are separated by lines. e.g.:
pattern: |
*.py
*.sh
exclude
Optional. Exclude patterns of target files. Same as -not -path [exclude]
of find
command.
e.g. ./.git/*
Patterns are separated by lines. e.g.:
exclude: |
./.git/*
./.cache/*
filter_mode
Optional. Filtering mode for the reviewdog command [added
,diff_context
,file
,nofilter
]. Default: added
.
fail_on_error
Optional. Exit code for reviewdog when errors are found [true
,false
]. Default: false
.
Example usage
.github/workflows/reviewdog.yml
name: reviewdog
on: [pull_request]
jobs:
misspell:
name: runner / misspell
runs-on: ubuntu-latest
steps:
- name: Check out code.
uses: actions/checkout@v4
- name: misspell
uses: reviewdog/action-misspell@v1
with:
github_token: ${{ secrets.github_token }}
locale: "US"