Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add check-spelling action #1222

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/actions/spell-check/advice.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<details>
<summary>
:pencil2: Contributor please read this
</summary>

* If the items listed above are names, please add them to `.github/actions/spell-check/dictionary/names.txt`.
* You can probably just add items into `.github/actions/spell-check/whitelist/jitsi.txt`.
* If you need to use a specific token in one place and it shouldn't generally be used, you can
add an item in `.github/actions/spell-check/patterns.txt`.

See the `README.md` in each directory for more information.
</details>

#### :warning: Reviewers
At present, the action that triggered this message will not show its :x: in this PR unless the branch is within this repository.
Thus, you **should** make sure that this comment has been addressed before merging this PR.
57 changes: 57 additions & 0 deletions .github/actions/spell-check/excludes.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
(?:^|/)dirs$
(?:^|/)go\.mod$
(?:^|/)go\.sum$
(?:^|/)package-lock\.json$
(?:^|/)sources(?:|\.dep)$
SUMS$
\.ai$
\.bmp$
\.cer$
\.class$
\.crl$
\.crt$
\.csr$
\.dll$
\.DS_Store$
\.eot$
\.eps$
\.exe$
\.gif$
\.graffle$
\.gz$
\.icns$
\.ico$
\.jar$
\.jpeg$
\.jpg$
\.key$
\.lib$
\.lock$
\.map$
\.min\..
\.mp3$
\.mp4$
\.otf$
\.pbxproj$
\.pdf$
\.pem$
\.png$
\.pom$
\.psd$
\.runsettings$
\.sig$
\.so$
\.svg$
\.svgz$
\.tar$
\.tgz$
\.ttf$
\.woff
\.xcf$
\.xls
\.xpm$
\.yml$
\.zip$
^\.editorconfig$
^\.github/actions/spell-check/
^\.gitignore$
12 changes: 12 additions & 0 deletions .github/actions/spell-check/patterns/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
The contents of each `.txt` file in this directory are merged together.
Each line is a Perl 5 regular expression.
Nothing is guaranteed about the order in which they're merged.
-- If this is a problem, please reach out.

Note: order of the contents of these files can matter.
Lines from an individual file are handled in file order.
Files are selected in alphabetical order.

* [patterns](patterns.txt) is the main list -- there is nothing
particularly special about the file name (beyond the extension which is
important).
6 changes: 6 additions & 0 deletions .github/actions/spell-check/patterns/domain.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# These are violations of TLD namespace
# They should use example.com and friends
# This file is here to shame the project into fixing things

fdfsgv1\@auth\.domain23\.com/pc3
focus@auth\.domain4?\.com/fdsfwetg
26 changes: 26 additions & 0 deletions .github/actions/spell-check/patterns/patterns.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
https://(?:(?:www\.|)youtube\.com|youtu.be)/[-a-zA-Z0-9?&=]*
https://groups\.google\.com/d/topic/[^/]+/[a-zA-Z0-9]+/discussion
-D(?:java|net|exec|maven|assembly|config|include|log|new|skip)
\\bjitsi
jitsi-videobridge
meet[-.]jit[-.]si

\?pwd=[0-9a-z]+
(?:pwd|ufrag)="[0-9a-z]+"
"(?:pwd|ufrag|id)": "[a-zA-Z0-9+]+"
id="[a-f0-9-]+"

4aca6ed6
7d2b7ecf

period\}ically

https://github.com/[^/]+/[^/]+/blob/[0-9a-f]+/

(?:[A-F0-9]{2}:){29}[A-F0-9]{2}
(?:0[Xx]|U\+|#)[a-f0-9A-FGgRr]{2,}[Uu]?[Ll]?\b
\{[0-9A-FA-F]{8}-(?:[0-9A-FA-F]{4}-){3}[0-9A-FA-F]{12}\}

\b([A-Za-z])\1{3,}\b

<((?:[a-z]+\.|)version)>[0-9.-]+?-[0-9a-z]+</\1>
9 changes: 9 additions & 0 deletions .github/actions/spell-check/whitelist/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
The contents of each `.txt` file in this directory are merged together.

* [jitsi](jitsi.txt) general jitsi specific whitelist items
* [debian](debian.txt) for debian specific magic
* [names](names.txt) for names or people/companies/projects
* [systemd](systemd.txt) for systemd specific stuff
* [whitelist](whitelist.txt) is the main whitelist -- there is nothing
particularly special about the file name (beyond the extension which is
important).
47 changes: 47 additions & 0 deletions .github/actions/spell-check/whitelist/debian.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
buildinfo
buildpackage
changelog
charset
chmod
chown
dch
DEBEMAIL
DEBFULLNAME
debhelper
deconfigure
deluser
devscripts
dh
dpkg
elif
getent
gettext
grep
groupadd
groupdel
installdeb
installinit
installsystemd
logz
manpage
msgid
msgstr
nf
nh
noscripts
nroff
OLDCONFIG
passwd
postinst
postrm
pwgen
roff
statoverride
systemctl
urandom
useradd
usermod
uuidgen
xmllint
xmpp
xpath
Loading