/
action.yaml
51 lines (51 loc) · 1.88 KB
/
action.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
name: "cspell-action"
description: "Spell Checker for Code"
author: "Street Side Software <info@streetsidesoftware.nl>"
inputs:
github_token:
description: >
Personal access token (PAT) used to fetch the repository commits. The PAT is configured
with the local git config, which enables your scripts to run authenticated git
commands. The post-job step removes the PAT.
We recommend using a service account with the least permissions necessary.
Also when generating a new PAT, select the least scopes necessary.
[Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
default: ${{ github.token }}
required: false
files:
description: >
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.
required: false
incremental_files_only:
description: >
Limit the files checked to the ones in the pull request or push.
default: "true"
required: false
config:
description: >
Path to `cspell.json`
required: false
root:
description: >
The point in the directory tree to start spell checking.
required: false
inline:
description: >
Notification level to use with inline reporting of spelling errors.
Allowed values are: warning, error, none
default: warning
required: false
strict:
description: >
Determines if the action should be failed if any spelling issues are found.
Allowed values are: true, false
default: "true"
required: false
runs:
using: "node16"
main: "./action/lib/main_root.js"
branding:
icon: "code"
color: "green"