Document some more parameters
This commit is contained in:
@@ -9,6 +9,54 @@ Any warnings or errors will be annotated in the Pull Request.
|
||||
uses: codespell-project/actions-codespell@master
|
||||
```
|
||||
|
||||
### Parameter: check_filenames
|
||||
|
||||
If set, check file names for spelling mistakes as well.
|
||||
|
||||
This parameter is optional; by default `codespell` will only check the file contents.
|
||||
|
||||
```
|
||||
uses: codespell-project/actions-codespell@master
|
||||
with:
|
||||
check_filenames: true
|
||||
```
|
||||
|
||||
### Parameter: check_hidden
|
||||
|
||||
If set, check hidden files (those starting with ".") for spelling mistakes as well.
|
||||
|
||||
This parameter is optional; by default `codespell` will not check hidden files.
|
||||
|
||||
```
|
||||
uses: codespell-project/actions-codespell@master
|
||||
with:
|
||||
check_hidden: true
|
||||
```
|
||||
|
||||
### Parameter: exclude_file
|
||||
|
||||
File with lines that should not be checked for spelling mistakes.
|
||||
|
||||
This parameter is optional; by default `codespell` will check all lines.
|
||||
|
||||
```
|
||||
uses: codespell-project/actions-codespell@master
|
||||
with:
|
||||
exclude_file: src/foo
|
||||
```
|
||||
|
||||
### Parameter: skip
|
||||
|
||||
Comma-separated list of files to skip (it accepts globs as well).
|
||||
|
||||
This parameter is optional; by default `codespell` won't skip any files.
|
||||
|
||||
```
|
||||
uses: codespell-project/actions-codespell@master
|
||||
with:
|
||||
skip: foo,bar
|
||||
```
|
||||
|
||||
### Parameter: path
|
||||
|
||||
Indicates the path to run `codespell` in.
|
||||
|
||||
Reference in New Issue
Block a user