Skip to content

Commit

Permalink
🤖 Exclude tests from spellcheck
Browse files Browse the repository at this point in the history 
Signed-off-by: Ettore Di Giacinto <[email protected]>
  • Loading branch information
@mudler
mudler committed Dec 10, 2022
1 parent 7f67d58 commit 497484d
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions .github/actions/spelling/excludes.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
(?:^|/)go\.sum$
(?:^|/)package(?:-lock|)\.json$
(?:^|/)vendor/
(?:^|/)test/
(?:^|/)tests/
(?:^|/)pkg/
(?:^|/)cmd/
(?:^|/)internal/
Expand All @@ -19,7 +19,6 @@
(?:^|/)docs/static/
(?:^|/)docs/themes/
CNAME$

Makefile$
\.a$
\.ai$
Expand Down

1 comment on commit 497484d

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log or 👼 SARIF report for details.

Unrecognized words (9)

CNCF
dflags
Earthfile
Hetzner
iah
Regex
Rtc
spellcheck
UUID

Previously acknowledged words that are now absent aaad aab Aarea abcde abcdefghijklmnopqrstuvwxyz addrs aea agetty Aissue algolia allexport Aopen ARegular Arelease ATIME Autoload autologin autoprefixer AWSEC azuretools bafae bashrc bce bcm bdd bdfb beforeahead bfaaeb bfe binpath blackfriday bootcmdline bootfile bootstraping bpf bpffs bpfilter breadcrumb browserconfig bufio bugzilla cae Catmull cbb ccb cccd CDLABEL cdroot ced certs cfcdfb cgi cgroup chardev chvt closemedium cloudconfig clusterplugin cmds CNAME cncf cni commd CONTAINERDIR containerrunner controlplane controlvm copytruncate cpuset cratonica createmedium createvm css ctx CTYPE ctz cvf danderson dba dbpath debianutils ded denisbrodbeck dfde dff diabling dirname dirs dmesg dmi dnf docsearch dracula dupliate dvd dvddrive eaa eab eae earthfile ebec eeprom efe emptydrive epel erikgeiser errcheck Errored Errorf fakegetty farbox favicon fce fedb Fflavor filepath fooz forceunmount FPV FRome FRONTEND fsck fsdu func gcs Getenv getty Getwd ghw githubembed githubusercontent gkas goarray godotenv gohugoio gojq goldmark gopkg gptfdisk greedly grubcustom grubinstall grubmenu gruboptions guestssh haideralipunjabi harderning hashicorp hdd HDMI hetzner hiddenentry highlighter hostiocache hugetlb hwe iconunix iface ifnames includedir inet initrdefi inittab installprompt Intn ioutil iputils IPv iscsid isoinfo itchyny jaypipes jetstack joho jpg jsondata kairososososos kernelcmd kubelet kvm Lastmod lastword len liah libexec linenos LINGUAS linuxefi loadfont logfile lsblk Lunr machineid makecache menuentry metaldata missingok MKISO mktemp mnt mocaccino modifyvm motd mountinfo mountpath mountpoint multierror Mutex NArg natpf navbar neetnet neovim nethogs nic noclear nodev noexec nolint NOLOCK nomodeset NOPASSWD nosuid Noto nowait Npqw nryfng nxadm oauth objs oemlabel oemtimeout oibaf omitempty oneshot openstack OSFS ostype otiai outdir outfile params peerguard permalinks permsisions pid pidfile pigz pki PKz Placeholders policycoreutils popd portcount postcss Printf Println processmanager promptkit pterm publicpath pushd pygments qeesung qga raspberrypi realpath recoverylabel recoverytoken regex relatime rels remoterecovery renovatebot respawn restorecon rmem rootdir rsakey rshared rtc runstage runtimes russross scaleway scss selinux Setenv shlex shortcodes showvminfo SIGINT SIGTERM snapd someuser spectrocloudcommunity Sprintf squashimg srv ssl standalone startvm STATEDIR stderr stdio stdout storageattach storagectl subdir subpath sudoers SUT svg syscall syset sysvinit TConfig temporarly testgist testvm textinput textmode tgz timezone tmpdir tmpfs tmux toml twpayne uint umounting unicode unmarshal unmarshalling unregistervm urfave userdata utc uuid vda vdi vfs vga virtserialport Virtualbox vmname vmtoolsd vscode vsliveshare vsys vultr webmanifest whitespaces wikipedia workaround WRONLY wsz XDG xml xvf xvzf xyproto ZCP :arrow_right:
To accept ✔️ these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands

... in a clone of the [email protected]:kairos-io/kairos.git repository
on the master branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/kairos-io/kairos/actions/runs/3665316268/attempts/1'
Available 📚 dictionaries could cover words not in the 📘 dictionary

This includes both expected items (1000) from .github/actions/spelling/expect.txt and unrecognized words (9)

Dictionary Entries Covers
cspell:cpp/src/cpp.txt 30216 117
cspell:software-terms/src/software-terms.txt 1237 104
cspell:node/node.txt 1768 43
cspell:python/src/python/python-lib.txt 3873 39
cspell:php/php.txt 2597 37
cspell:aws/aws.txt 218 24
cspell:npm/npm.txt 288 23
cspell:typescript/typescript.txt 1211 20
cspell:win32/src/win32.txt 53509 18
cspell:node/src/node-old.txt 730 18

Consider adding them using (in .github/workflows/spelling.yml):

      with:
        extra_dictionaries:
          cspell:cpp/src/cpp.txt
          cspell:software-terms/src/software-terms.txt
          cspell:node/node.txt
          cspell:python/src/python/python-lib.txt
          cspell:php/php.txt
          cspell:aws/aws.txt
          cspell:npm/npm.txt
          cspell:typescript/typescript.txt
          cspell:win32/src/win32.txt
          cspell:node/src/node-old.txt

To stop checking additional dictionaries, add:

      with:
        check_extra_dictionaries: ''
Errors (1)

See the 📜action log or 👼 SARIF report for details.

❌ Errors Count
❌ forbidden-pattern 18

See ❌ Event descriptions for more information.

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Please sign in to comment.