Skip to content

Commit 0b993da

Browse files
Merge pull request #3172 from jsoref/spell-check
ci: Update to check-spelling@v0.0.21
2 parents 5247432 + 6d706dc commit 0b993da

17 files changed

Lines changed: 933 additions & 810 deletions

File tree

.github/CONTRIBUTORS.svg

Lines changed: 1 addition & 1 deletion
Loading

.github/actions/spelling/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ File | Purpose | Format | Info
88
[excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes)
99
[only.txt](only.txt) | Only check matching files (applied after excludes) | perl regular expression | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only)
1010
[patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
11+
[candidate.patterns](candidate.patterns) | Patterns that might be worth adding to [patterns.txt](patterns.txt) | perl regular expression with optional comment block introductions (all matches will be suggested) | [candidates](https://github.com/check-spelling/check-spelling/wiki/Feature:-Suggest-patterns)
12+
[line_forbidden.patterns](line_forbidden.patterns) | Patterns to flag in checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
1113
[expect.txt](expect.txt) | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect)
12-
[advice.txt](advice.txt) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice)
14+
[advice.md](advice.md) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice)
1315

14-
Note: you can replace any of these files with a directory by the same name (minus the `.txt` extension) and
15-
then include multiple files (with a `.txt` extension) inside that directory to merge multiple files together.
16+
Note: you can replace any of these files with a directory by the same name (minus the suffix)
17+
and then include multiple files inside that directory (with that suffix) to merge multiple files together.

.github/actions/spelling/advice.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,25 @@
11
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
2+
<details><summary>If the flagged items are :exploding_head: false positives</summary>
23

3-
<details><summary>If you see a bunch of garbage</summary>
4+
If items relate to a ...
5+
* binary file (or some other file you wouldn't want to check at all).
46

5-
If it relates to a ...
6-
<details><summary>well-formed pattern</summary>
7+
Please add a file path to the `excludes.txt` file matching the containing file.
78

8-
See if there's a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it.
9-
10-
If not, try writing one and adding it to the `patterns.txt` file.
9+
File paths are Perl 5 Regular Expressions - you can [test](
10+
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
1111

12-
Patterns are Perl 5 Regular Expressions - you can [test](
13-
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
12+
`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
13+
../tree/HEAD/README.md) (on whichever branch you're using).
1414

15-
Note that patterns can't match multiline strings.
16-
</details>
17-
<details><summary>binary-ish string</summary>
15+
* well-formed pattern.
1816

19-
Please add a file path to the `excludes.txt` file instead of just accepting the garbage.
17+
If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
18+
try adding it to the `patterns.txt` file.
2019

21-
File paths are Perl 5 Regular Expressions - you can [test](
22-
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
20+
Patterns are Perl 5 Regular Expressions - you can [test](
21+
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
2322

24-
`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
25-
../tree/HEAD/README.md) (on whichever branch you're using).
26-
</details>
23+
Note that patterns can't match multiline strings.
2724

2825
</details>

.github/actions/spelling/allow.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
CODEOWNERS
2+
codeowners
3+
CORS
4+
cors
5+
github
6+
https
7+
ssh
8+
SUSE
9+
Suse
10+
ubuntu
11+
workarounds

0 commit comments

Comments
 (0)