Skip to content

Commit 7c7c0ce

Browse files
committed
improve example of configuration in docs/config.md
1 parent b05a5a7 commit 7c7c0ce

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

docs/config.md

+15-9
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Note: If you're using [Super-Linter][], the file should be placed in a different
1616
```yaml
1717
# Configuration related to self-hosted runner.
1818
self-hosted-runner:
19-
# Labels of self-hosted runner in array of string.
19+
# Labels of self-hosted runner in array of strings.
2020
labels:
2121
- linux.2xlarge
2222
- windows-latest-xl
@@ -35,22 +35,28 @@ paths:
3535
.github/workflows/**/*.yaml:
3636
# List of regular expressions to filter errors by the error messages.
3737
ignore:
38-
- context ".+" is not allowed here
39-
- label ".+" is unknown\. available labels are
38+
# Ignore the specific error from shellcheck
39+
- 'shellcheck reported issue in this script: SC2086:.+'
40+
# This pattern only matches '.github/workflows/release.yaml' file.
41+
.github/workflows/release.yaml:
42+
ignore:
43+
# Ignore errors from the old runner check. This may be useful for (outdated) self-hosted runner environment.
44+
- 'the runner of ".+" action is too old to run on GitHub Actions'
4045
```
4146
4247
- `self-hosted-runner`: Configuration for your self-hosted runner environment.
4348
- `labels`: Label names added to your self-hosted runners as list of pattern. Glob syntax supported by [`path.Match`][pat]
4449
is available.
4550
- `config-variables`: [Configuration variables][vars]. When an array is set, actionlint will check `vars` properties strictly.
4651
An empty array means no variable is allowed. The default value `null` disables the check.
47-
- `paths`: Configurations for specific file paths. This is a mapping from a file path glob pattern and the corresponding
52+
- `paths`: Configurations for specific file path patterns. This is a mapping from a glob pattern and the corresponding
4853
configuration.
49-
- `{glob}`: A file path glob pattern to apply the configuration. The path separator is always '/'. it is matched to the
50-
relative path from the repository root. For example, `.github/workflows/**/*.yaml` matches all the workflow files (its
51-
name ending with `.yaml`). For the glob syntax, please read the [doublestar][] library's documentation.
52-
- `ignore`: The configuration to ignore (filter) the errors by the error messages. This is an array of regular expressions.
53-
It is similar to the `-ignore` command line option.
54+
- `{glob}`: A file path glob pattern to apply the configuration. The path separator is always '/'. It is matched to the
55+
relative path from the repository root. For example `.github/workflows/**/*.yaml` matches all the workflow files (with
56+
`.yaml` file extension). For the glob syntax, please read the [doublestar][] library's documentation.
57+
- `ignore`: The configuration to ignore (filter) the errors by the error messages. This is an array of regular
58+
expressions. When one of the patterns matches the error message, the error will be ignored. It's similar to the
59+
`-ignore` command line option.
5460

5561
## Generate the initial configuration
5662

0 commit comments

Comments
 (0)