Tame the failing spellcheck job (#620)

* .github/workflows/spelling/excludes.txt: do not check CHANGES.old (and its commit hash strings), AUTHORS and generated man pages Signed-off-by: Jim Klimov <[email protected]> * .github/workflows/spelling/excludes.txt: allow certain words from IT world generally and znapzend in particular Signed-off-by: Jim Klimov <[email protected]> * znapzendzetup: doc typo fix READNE=>README Signed-off-by: Jim Klimov <[email protected]> * Fix some trailing whitespaces Signed-off-by: Jim Klimov <[email protected]> * Dockerfile: ensure prerequisites for self-testing Signed-off-by: Jim Klimov <[email protected]> * Address Warning: deprecation: please rename 'whitelist' to 'expect' Signed-off-by: Jim Klimov <[email protected]> * Address Warning: .github/workflows//spelling/patterns.txt: line 1, columns 10-11, Warning - no newline at eof (no-newline-at-eof) * .github/workflows/spelling/expect.txt: "coprs" is a word in our context Signed-off-by: Jim Klimov <[email protected]> * Typo fix repoen=>reopen Signed-off-by: Jim Klimov <[email protected]> * .github/workflows/spelling/expect.txt: "HAARG" is a word in our context (dev name) Signed-off-by: Jim Klimov <[email protected]> * Typo fix flaged=>flagged Signed-off-by: Jim Klimov <[email protected]> * .github/workflows/spelling/expect.txt: fix spelling for debian/znapzend.links.in Signed-off-by: Jim Klimov <[email protected]> * .github/workflows/spelling/excludes.txt: fix filename patterns Signed-off-by: Jim Klimov <[email protected]> * .github/workflows/spelling.yml: bump action version Signed-off-by: Jim Klimov <[email protected]> * .github/workflows/spelling/expect.txt: drop uppercase and plural variants Signed-off-by: Jim Klimov <[email protected]> * Typo fix ZnapZends=>ZnapZend's Signed-off-by: Jim Klimov <[email protected]> * .github/workflows/spelling/expect.txt: update with words from perl sources Signed-off-by: Jim Klimov <[email protected]> * .github/workflows/spelling/expect.txt: ignore Makefile.am Signed-off-by: Jim Klimov <[email protected]> * .github/workflows/spelling/excludes.txt: ignore init/org.znapzend.plist.in Signed-off-by: Jim Klimov <[email protected]> * .github/workflows/spelling/expect.txt: like coprs again (over copr) Signed-off-by: Jim Klimov <[email protected]> --------- Signed-off-by: Jim Klimov <[email protected]>
oetiker · Jan 9, 2024 · 8d64694 · 8d64694
1 parent bb43621
commit 8d64694
Show file tree

Hide file tree

Showing 13 changed files with 89 additions and 19 deletions.
diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml
@@ -13,7 +13,7 @@ jobs:
     - uses: actions/checkout@v2
       with:
         fetch-depth: 0
-    - uses: check-spelling/[email protected].19
+    - uses: check-spelling/[email protected].22
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         bucket: .github/workflows/

diff --git a/.github/workflows/spelling/excludes.txt b/.github/workflows/spelling/excludes.txt
@@ -1,3 +1,5 @@
+^debian/znapzend\.links\.in
+^init/org\.znapzend\.plist\.in$
 (?:^|/)go\.mod$
 (?:^|/)go\.sum$
 (?:^|/)package-lock\.json$
@@ -47,7 +49,12 @@ SUMS$
 \.xpm$
 \.yml$
 \.zip$
+\.1$
+Makefile\.am$
+^AUTHORS$
 ^CHANGES$
+^CHANGES\.old$
 ^excludes\.txt$
 ^whitelist\.txt$
+^expect\.txt$
 ^\.github/workflows/spelling/
diff --git a/.github/workflows/spelling/whitelist.txt → .github/workflows/spelling/expect.txt b/.github/workflows/spelling/whitelist.txt → .github/workflows/spelling/expect.txt
@@ -8,6 +8,7 @@ admins
 Affero
 aix
 alpinelinux
+amd
 AMTAR
 anewconfig
 anotherchild
@@ -20,6 +21,7 @@ ARGV
 asciiphil
 asdf
 astring
+atime
 attr
 austingroupbugs
 autocommit
@@ -39,6 +41,7 @@ badkey
 bak
 Balert
 bashisms
+bashrc
 Bcreate
 Bdebug
 Bdelete
@@ -53,17 +56,20 @@ Binfo
 blib
 Bnoaction
 Bnot
+bossert
 bpatsubst
 Bpidfile
 Bpost
 Bpre
 bserv
 Bsyslog
+buildpackage
 Bwarning
 Bzfs
 Bznapzend
 Bznapzendzetup
 Bznapzendztatz
+canmount
 CBuilder
 cfg
 cgi
@@ -81,6 +87,8 @@ chof
 chown
 chowncmd
 chownprog
+chroot
+cmds
 cmp
 cmpprog
 cnf
@@ -97,6 +105,7 @@ conftest
 conftools
 CONNEC
 Consor
+coprs
 copyleft
 coreutils
 COUNTFAIL
@@ -109,7 +118,9 @@ cpanmin
 CPANSNAPV
 cpio
 cpprog
+crlf
 crt
+CVS
 Cwd
 CWORD
 CXX
@@ -121,18 +132,22 @@ daemonized
 DAGOLDEN
 datadir
 DBD
+de'u
+debhelper
 debian
+dedup
 defn
 defun
 deps
 dest
 DESTDIR
 destfail
 desttemp
-de'u
 dirname
+dirs
 distclean
 distdir
+DISTRIBUTIONNAME
 distro
 dmp
 dnf
@@ -142,6 +157,7 @@ dockerfile
 DOCTYPE
 DOITPROG
 donotask
+dpkg
 DRBASE
 dsa
 dsq
@@ -154,10 +170,12 @@ dstdsname
 DSTFILE
 dstname
 dsttmp
+DTDs
 DTIPS
 DTRT
 dummydataset
 ebuild
+ecdsa
 eckels
 egrep
 elif
@@ -167,6 +185,7 @@ endif
 ENTRYPOINT
 envval
 envvar
+eol
 errline
 errmsg
 esac
@@ -179,6 +198,7 @@ exitstatus
 exitval
 expr
 EXTRADIST
+failsafes
 Fcntl
 fedorainfracloud
 fh
@@ -195,6 +215,7 @@ foced
 foreach
 forkcall
 FQSN
+FRONTEND
 fsf
 gerczei
 Getopt
@@ -212,16 +233,20 @@ Gregy
 grep
 gtar
 gz
+HAARG
 hadfl
 Hassler
 Heitm
 heitmueller
 HMSz
+homedir
 Honame
 hostname
+howtogeek
 html
 http
 Hypnotoad
+ico
 Icommand
 Icommon
 Icreate
@@ -242,6 +267,7 @@ Ilimited
 illumos
 imandir
 img
+incrementals
 ings
 inh
 inheritedattr
@@ -274,8 +300,10 @@ Ivalue
 Iznapzendzetup
 JB
 JBERGER
+jenkins
 jimklimov
 JSON
+keygen
 killproc
 Klimov
 LASTCOMMON
@@ -294,6 +322,7 @@ localattr
 localhost
 localtime
 loctext
+logbias
 logfile
 loglevel
 logto
@@ -303,6 +332,7 @@ lsb
 ltrim
 mailprog
 MAINPID
+Makefiles
 makeinfo
 manpage
 manpath
@@ -388,32 +418,39 @@ pkill
 plaintar
 plist
 plugin
+png
 populat
 posix
 prebuilt
 precmd
 prefork
 PREREQ
+primarycache
 printf
 printsrc
 propname
 propstring
 propval
+Proxmox
 psgi
 pstcmd
 pwd
 qprefix
 qq
 qw
 qwe
+rbash
 RCAPUTO
 README
 recurseparent
 recv
 recvu
 redhat
+refquota
+refreservation
 regex
 regexing
+remotehost
 RESFINAL
 respawn
 resync
@@ -428,19 +465,23 @@ rootfs
 rootfs'es
 rpool
 rr
+rsa
+rsync
 runlevel
 runonce
 rw
 sbin
 sbindir
 screation
 scriptversion
+secondarycache
 SEENDST
 SEENSRC
 selftest
 sendmail
 setsid
 shellwords
+shlibs
 shtml
 SIGHUP
 SIGINT
@@ -450,7 +491,9 @@ smartmatch
 smf
 snapname
 snapsuffix
+snaptime
 SNO
+softprops
 solaris
 sourced
 sourcemissing
@@ -477,11 +520,13 @@ stdout
 stefan
 stip
 strftime
+stringify
 stripcmd
 stripprog
 strptime
 subdataset
 SUBDIRS
+substvars
 subsys
 sudo
 sudoers
@@ -492,6 +537,7 @@ svcinstall
 SVCINSTALLDIR
 svcname
 svg
+svn
 symlink
 synczbe
 sys
@@ -508,6 +554,7 @@ tabledata
 tarball
 tardir
 TARNAME
+tattr
 tempfile
 templated
 testsuite
@@ -517,19 +564,23 @@ tfilesystem
 tgerczei
 thirdparty
 timeslot
+tinherit
 TION
 tium
+tlowmem
 TLS
 tmp
 tmpdir
 tobi
 todo
 TOTHINK
+tpropnames
+trecurse
 troff
 tsformat
 tsnapshot
 tzoffset
-Ubuntu
+ubuntu
 uid
 umask
 umontreal
@@ -545,7 +596,9 @@ Uplevel
 url
 usbbackup
 usedbysnapshot
+useradd
 userland
+usermod
 username
 userprop
 usr
@@ -582,6 +635,7 @@ xml
 xno
 Xproperties
 xset
+xtrue
 yacc
 YAML
 Ymd
@@ -599,6 +653,7 @@ ZFSW
 ZFSZONEROOTS
 ZL
 znap
+znapdest
 ZNAPVER
 znapzend
 ZNAPZENDOPTIONS

diff --git a/.github/workflows/spelling/patterns.txt b/.github/workflows/spelling/patterns.txt
@@ -1 +1 @@
-cpanfile.+
+cpanfile.+
diff --git a/Dockerfile b/Dockerfile
@@ -40,5 +40,8 @@ CMD [ "znapzend --logto=/dev/stdout" ]
 ##### Tests
 FROM builder as test
 
+RUN \
+  cpan Devel::Cover
+
 RUN \
   ./test.sh