| files | Define glob patterns to filter the files to be checked. Use a new line between patterns to define multiple patterns.
The default is to check ALL files that were changed in in the pull_request or push.
Note: `ignorePaths` defined in cspell.json still apply.
| no | — |
| incremental_files_only | Limit the files checked to the ones in the pull request or push.
| no | true |
| config | Path to CSpell configuration file, i.e. `cspell.json` or `cspell.config.yaml`. If not provided, the spell checker will search for the nearest configuration file.
| no | — |
| root | The point in the directory tree to start spell checking.
| no | — |
| inline | Notification level to use with inline reporting of spelling errors. Allowed values are: warning, error, none
| no | warning |
| treat_flagged_words_as_errors | Treat flagged / forbidden words as errors. Allowed values are: true, false
| — | false |
| strict | Determines if the action should be failed if any spelling issues are found.
Allowed values are: true, false
| no | true |
| suggestions | Generate Spelling suggestions.
| no | false |
| verbose | Increase the log output to include progress.
Allowed values are: true, false
| no | false |
| check_dot_files | Check files and directories starting with `.`.
- "true" - glob searches will match against `.dot` files.
- "false" - `.dot` files will NOT be checked.
- "explicit" - glob patterns can match explicit `.dot` patterns.
| no | explicit |
| use_cspell_files | Use the `files` setting from the CSpell configuration file.
- "true" - Overrides the `input.files` setting.
- "false" - Use the `input.files` setting.
| no | false |
| report | Set how unknown words are reported.
- "all" - all issues are reported.
- "simple" - only unknown words are reported.
- "typos" - only typos are reported.
- "flagged" - only flagged words are reported.
| no | — |
| summary | Include a summary of the results in the output.
Allowed values are: "true", "false"
| no | false |