| github_token | GITHUB_TOKEN | yes | ${{ github.token }} |
| github_base_ref | Pull request target branch name | no | ${{ github.base_ref }} |
| working-directory | working directory | no | ${{ github.workspace }} |
| level | Report level for reviewdog [info,warning,error] | no | error |
| reporter | Reporter of reviewdog command [github-check,github-pr-review]. | no | github-check |
| filter_mode | Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
Default is file.
| no | file |
| fail_on_error | Exit code for reviewdog when errors are found [true,false]
Default is `false`.
| no | false |
| reviewdog_version | reviewdog version | no | v0.21.0 |
| sqlfluff_version | sqlfluff version (pinned default). Set this input to override, for example to stay on SQLFluff 3.x.
| no | 4.1.0 |
| sqlfluff_command | The sub command of sqlfluff. One of lint and fix | no | lint |
| paths | PATH is the path to a sql file or directory to lint.
This can be either a file ('path/to/file.sql'), a path ('directory/of/sql/files'), a single ('-') character to indicate reading from *stdin* or a dot/blank ('.'/' ') which will be interpreted like passing the current working directory as a path argument.
| yes | — |
| file_pattern | The regular expression to filter checked files | no | \.sql$ |
| encoding | Specifiy encoding to use when reading and writing files. Defaults to autodetect. | no | "" |
| config | Include additional config file.
By default the config is generated from the standard configuration files described in the documentation.
This argument allows you to specify an additional configuration file that overrides the standard configuration files.
N.B. cfg format is required.
| no | "" |
| exclude-rules | Exclude specific rules.
For example specifying –exclude-rules L001 will remove rule L001 (Unnecessary trailing whitespace) from the set of considered rules.
This could either be the allowlist, or the general set if there is no specific allowlist.
Multiple rules can be specified with commas e.g. –exclude-rules L001,L002 will exclude violations of rule L001 and rule L002.
| no | "" |
| rules | Narrow the search to only specific rules.
For example specifying –rules L001 will only search for rule L001 (Unnecessary trailing whitespace).
Multiple rules can be specified with commas e.g. –rules L001,L002 will specify only looking for violations of rule L001 and rule L002.
| no | "" |
| templater | The templater to use | no | "" |
| disable-noqa | Set this flag to ignore inline noqa comments. | no | "" |
| dialect | The dialect of SQL to lint | no | "" |
| processes | The number of parallel processes to run. | no | 2 |
| extra_requirements_txt | A path to your custom `requirements.txt` to install extra modules for your dbt adapters.
Please make sure not to contain `sqlfluff` and its dependent packages, because the action can be broken by the conflicts.
| no | "" |