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

Removed SpellingBot for the time being #1079

Merged
merged 1 commit into from
Jan 4, 2022
Merged

Conversation

ellistarn
Copy link
Contributor

1. Issue, if available:

2. Description of changes:

3. Does this change impact docs?

  • Yes, PR includes docs updates
  • Yes, issue opened: link to issue
  • No

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@netlify
Copy link

netlify bot commented Jan 4, 2022

✔️ Deploy Preview for karpenter-docs-prod canceled.

🔨 Explore the source changes: 095afc8

🔍 Inspect the deploy log: https://app.netlify.com/sites/karpenter-docs-prod/deploys/61d49597c443aa00074ba126

@github-actions
Copy link
Contributor

github-actions bot commented Jan 4, 2022

@check-spelling-bot Report

🔴 Please review

See the files view or the action log for details.

Unrecognized words (472)
aaaaaaaaa
addon
adfdb
admissionregistration
aeccd
Affero
alertmanager
amazonvpc
amd
amdgpu
amiid
apic
apiextensions
apimachinery
apiobject
apiserver
APIV
appsv
args
asciicheck
authn
authz
Autoconfigure
autogenerated
autoprefixer
autoscaler
awscli
AWSEC
awserr
awslabs
awsmanpol
AWSTo
azs
bacd
baseurl
battletest
baz
bba
beorn
binpack
binpacking
blackfriday
blog
bmizerany
bootstrappers
bottlerocket
breadcrumb
brightgreen
browserconfig
btn
Burstable
bwagner
calcs
CAPI
Catmull
cce
cespare
cfn
cheney
clg
clientgoscheme
Clientset
cloudprovider
cloudprovidermetrics
cmp
cmw
cncf
cni
codebase
codegen
colocation
configmap
containerd
controllerruntime
corev
coveraged
coverpkg
coverprofile
crd
creativecommons
crmetrics
ctx
currentpath
daemonset
datasource
davec
davecgh
ddd
ddf
Debugf
deckarep
deepcopy
defragmentation
deletecopy
deprov
deprovisioned
deprovisioning
deserialize
Deserializer
dirname
dirs
disjoiner
distro
dkr
DNSIP
Dnz
docsy
dropdown
ebd
ece
eeeca
eksctl
EKv
elif
ellistarn
emitterc
emr
ENABLEGITINFO
eni
envtest
errcheck
errorlint
etarn
ETCD
evanphx
evenodd
evictable
expr
FAQs
farbox
fargate
favicon
fbbde
fcd
fddec
FFD
FFFFFF
fileno
filesystem
finalizer
finditer
fsnotify
fullname
fzipp
gci
gcp
gcr
getcwd
Ghods
github
gmail
gnet
gocache
gocyclo
GOFLAGS
gofuzz
golangci
goldmark
golicense
gomega
gomod
gomodules
google
googleapis
gosec
gpu
gpuapp
grafana
grep
groupcache
Groupless
gvk
Hashi
hashicorp
hashstructure
haspopup
healthz
heatmap
hebdf
highlighter
homepage
Hostnames
HPC
href
https
hvm
Hypervisor
iamidentitymapping
iamserviceaccount
ianlewis
ical
ico
iconx
ics
Idempotently
iface
imdario
IMDS
img
Impl
Infof
injectabletime
inkscape
instancegroup
instancetype
intstr
irsa
issuecomment
itemgetter
jbk
JJc
jjones
jmespath
jsonencode
jsonpatch
jsonpath
Jvd
karpenter
kcm
Kirill
kld
klog
KMGTPE
knative
knativeinjection
kube
kubebuilder
Kubecon
kubeconfig
kubectl
kubelet
kubernetes
labelledby
ldflags
libyaml
linenos
linewidth
linting
localhost
loglevel
logr
LRMHZ
lru
MAKECMDGOALS
markdownify
marvinpinto
matttproud
maxskew
mergo
metav
MGTPE
mikefarah
minheap
mitchellh
Mizerany
mkdir
mktemp
mmap
Mmpl
mozilla
msapplication
Mugp
multierr
mutatingwebhookconfigurations
myapp
mygpucontainer
mygpupod
myimage
Mylund
myprofile
namespaced
namespacedname
navbar
netural
nilset
nindent
njtran
Nlc
nodekubernetesioinstance
nodeselector
nolint
NONINFRINGEMENT
noopener
norwoodj
notkaperner
Npi
npm
numk
Nvb
nvidia
nyi
Ogier
oidc
ojsonpath
onboarded
onsi
openapi
OSX
outputdir
overwriter
packables
Pallinder
params
parserc
patrickmn
pdb
percentunit
permalink
piechart
pipefail
Placeholders
planetscale
Pluralizion
PODNAME
podspec
pointradius
Poppins
postcss
prateekgogia
prealloc
preemptible
printf
procfs
protobuf
protocolbuffers
provisionable
provisioners
ptr
pwd
pygments
qfdeof
qps
QZZQ
Rabenstein
randomdata
rbac
rdf
readerc
readme
readyz
relref
reqs
requeue
resourcesemantics
retriable
Retryer
retval
rgba
roadmap
russross
Saryerwinnie
scalability
scannerc
sdk
searchdirectory
searchpath
serializer
serviceaccount
sharedmain
Shortcode
should've
sigs
sitemap
sodipodi
soundcloud
sourceforge
spf
SPJ
src
SSMAPI
ssmiface
stacktrace
standalone
startinformers
stderr
stdin
stdout
stylecheck
subdir
subneta
subnetb
subnetc
subreconciler
subresource
substr
sudo
svg
sys
tabern
templating
TEMPOUT
terraform
testclient
testzone
Tgc
tilecolor
timepicker
timezone
todo
toolchain
tooltip
topdown
tparallel
tsbuckets
ttl
uber
uberwriter
ubuntu
uid
Uncomment
unconstrain
underutilized
Unescape
uninstall
uninstalling
unparam
unschedulable
updatecopy
urls
userdata
userguide
username
usr
utf
utilruntime
utils
Utuw
uuid
UVj
validatingwebhookconfigurations
vals
vcpu
Vec
versioned
virtualization
virtualized
vmimport
VRHVd
walkthrough
westzones
wiki
wikipedia
wildcards
WJRUF
workqueue
writerc
writerow
www
xargs
XAu
xaxis
xlarge
xlink
xmlns
xvda
xxhash
xyproto
yaml
yamlh
yamlprivateh
yaxes
yaxis
YBuckets
yml
Ymt
youtu
youtube
YXIu
yyyy
zapr
ZGVv
ZWJk
Available dictionaries could cover words not in the dictionary

cspell:cpp/cpp.txt (104293) covers 66 of them
cspell:html/html.txt (542) covers 9 of them
cspell:django/django.txt (2342) covers 9 of them
cspell:java/java.txt (33524) covers 8 of them
cspell:fullstack/fullstack.txt (181) covers 8 of them
cspell:css/css.txt (993) covers 7 of them
cspell:npm/npm.txt (671) covers 6 of them
cspell:filetypes/filetypes.txt (337) covers 6 of them
cspell:scala/scala.txt (2752) covers 5 of them
cspell:python/python.txt (364) covers 5 of them
cspell:lua/lua.txt (391) covers 4 of them
cspell:rust/rust.txt (112) covers 3 of them
cspell:ruby/ruby.txt (354) covers 2 of them
cspell:node/node.txt (9611) covers 2 of them
cspell:bash/bash-words.txt (22) covers 2 of them
cspell:csharp/csharp.txt (123) covers 1 of them
cspell:ada/ada.txt (72) covers 1 of them

Consider adding them using:

      with:
        extra_dictionaries:
          cspell:cpp/cpp.txt
          cspell:html/html.txt
          cspell:django/django.txt
          cspell:java/java.txt
          cspell:fullstack/fullstack.txt
          cspell:css/css.txt
          cspell:npm/npm.txt
          cspell:filetypes/filetypes.txt
          cspell:scala/scala.txt
          cspell:python/python.txt
          cspell:lua/lua.txt
          cspell:rust/rust.txt
          cspell:ruby/ruby.txt
          cspell:node/node.txt
          cspell:bash/bash-words.txt
          cspell:csharp/csharp.txt
          cspell:ada/ada.txt

To stop checking additional dictionaries, add:

      with:
        check_extra_dictionaries: ''
Some files were automatically ignored

These sample patterns would exclude them:

^\Qcharts/index.yaml\E$
^\Qcharts/karpenter-0.1.1.tgz\E$
^\Qcharts/karpenter-0.1.2.tgz\E$
^\Qcharts/karpenter-0.1.3.tgz\E$
^\Qcharts/karpenter-0.2.0.tgz\E$
^\Qcharts/karpenter-0.2.1.tgz\E$
^\Qcharts/karpenter-0.2.2.tgz\E$
^\Qcharts/karpenter-0.2.3.tgz\E$
^\Qcharts/karpenter-0.2.4.tgz\E$
^\Qcharts/karpenter-0.2.5.tgz\E$
^\Qcharts/karpenter-0.2.6.tgz\E$
^\Qcharts/karpenter-0.2.7.tgz\E$
^\Qcharts/karpenter-0.2.8.tgz\E$
^\Qcharts/karpenter-0.2.9.tgz\E$
^\Qcharts/karpenter-0.3.0.tgz\E$
^\Qcharts/karpenter-0.3.1.tgz\E$
^\Qcharts/karpenter-0.3.2.tgz\E$
^\Qcharts/karpenter-0.3.3.tgz\E$
^\Qcharts/karpenter-0.3.4.tgz\E$
^\Qcharts/karpenter-0.4.0.tgz\E$
^\Qcharts/karpenter-0.4.1.tgz\E$
^\Qcharts/karpenter-0.4.2.tgz\E$
^\Qcharts/karpenter-0.4.3.tgz\E$
^\Qcharts/karpenter-0.5.0.tgz\E$
^\Qcharts/karpenter-0.5.1.tgz\E$
^\Qcharts/karpenter-0.5.2.tgz\E$
^\Qcharts/karpenter-0.5.3.tgz\E$
^\Qgo.mod\E$
^\Qgo.sum\E$
^\Qtools/go.mod\E$
^\Qtools/go.sum\E$
^\Qwebsite/content/en/background.png\E$
^\Qwebsite/package-lock.json\E$
^\Qwebsite/static/banner.png\E$
^\Qwebsite/static/favicons/apple-touch-icon-180x180.png\E$
^\Qwebsite/static/favicons/favicon-16x16.png\E$
^\Qwebsite/static/favicons/favicon-32x32.png\E$
^\Qwebsite/static/favicons/pwa-192x192.png\E$
^\Qwebsite/static/favicons/pwa-512x512.png\E$
^\Qwebsite/static/favicons/tile150x150.png\E$
^\Qwebsite/static/favicons/tile310x150.png\E$
^\Qwebsite/static/favicons/tile310x310.png\E$
^\Qwebsite/static/favicons/tile70x70.png\E$
^\Qwebsite/static/full_logo.png\E$
^\Qwebsite/static/karpenter-overview.png\E$
^\Qwebsite/static/logo.png\E$
^\Qwebsite/static/termination-state-machine.png\E$

You should consider excluding directory paths (e.g. (?:^|/)vendor/), filenames (e.g. (?:^|/)yarn\.lock$), or file extensions (e.g. \.gz$)

You should consider adding them to:

.github/actions/spelling/excludes.txt

File matching is via Perl regular expressions.

To check these files, more of their words need to be in the dictionary than not. You can use patterns.txt to exclude portions, add items to the dictionary (e.g. by adding them to allow.txt), or fix typos.

Warnings (1)

See Warning descriptions for more information.

Warning Count
noisy-file 47
To accept these unrecognized words as correct, run the following commands

... in a clone of the [email protected]:ellistarn/karpenter.git repository
on the main branch:

update_files() {
perl -e '
my $new_expect_file=".github/actions/spelling/expect.txt";
use File::Path qw(make_path);
use File::Basename qw(dirname);
make_path (dirname($new_expect_file));
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"$patch_add"');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a)."-".$a cmp lc($b)."-".$b} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;
system("git", "add", $new_expect_file);
'
(cat '.github/actions/spelling/excludes.txt' - <<EOF
^\Qcharts/index.yaml\E$
^\Qcharts/karpenter-0.1.1.tgz\E$
^\Qcharts/karpenter-0.1.2.tgz\E$
^\Qcharts/karpenter-0.1.3.tgz\E$
^\Qcharts/karpenter-0.2.0.tgz\E$
^\Qcharts/karpenter-0.2.1.tgz\E$
^\Qcharts/karpenter-0.2.2.tgz\E$
^\Qcharts/karpenter-0.2.3.tgz\E$
^\Qcharts/karpenter-0.2.4.tgz\E$
^\Qcharts/karpenter-0.2.5.tgz\E$
^\Qcharts/karpenter-0.2.6.tgz\E$
^\Qcharts/karpenter-0.2.7.tgz\E$
^\Qcharts/karpenter-0.2.8.tgz\E$
^\Qcharts/karpenter-0.2.9.tgz\E$
^\Qcharts/karpenter-0.3.0.tgz\E$
^\Qcharts/karpenter-0.3.1.tgz\E$
^\Qcharts/karpenter-0.3.2.tgz\E$
^\Qcharts/karpenter-0.3.3.tgz\E$
^\Qcharts/karpenter-0.3.4.tgz\E$
^\Qcharts/karpenter-0.4.0.tgz\E$
^\Qcharts/karpenter-0.4.1.tgz\E$
^\Qcharts/karpenter-0.4.2.tgz\E$
^\Qcharts/karpenter-0.4.3.tgz\E$
^\Qcharts/karpenter-0.5.0.tgz\E$
^\Qcharts/karpenter-0.5.1.tgz\E$
^\Qcharts/karpenter-0.5.2.tgz\E$
^\Qcharts/karpenter-0.5.3.tgz\E$
^\Qgo.mod\E$
^\Qgo.sum\E$
^\Qtools/go.mod\E$
^\Qtools/go.sum\E$
^\Qwebsite/content/en/background.png\E$
^\Qwebsite/package-lock.json\E$
^\Qwebsite/static/banner.png\E$
^\Qwebsite/static/favicons/apple-touch-icon-180x180.png\E$
^\Qwebsite/static/favicons/favicon-16x16.png\E$
^\Qwebsite/static/favicons/favicon-32x32.png\E$
^\Qwebsite/static/favicons/pwa-192x192.png\E$
^\Qwebsite/static/favicons/pwa-512x512.png\E$
^\Qwebsite/static/favicons/tile150x150.png\E$
^\Qwebsite/static/favicons/tile310x150.png\E$
^\Qwebsite/static/favicons/tile310x310.png\E$
^\Qwebsite/static/favicons/tile70x70.png\E$
^\Qwebsite/static/full_logo.png\E$
^\Qwebsite/static/karpenter-overview.png\E$
^\Qwebsite/static/logo.png\E$
^\Qwebsite/static/termination-state-machine.png\E$
EOF
) |grep .|
sort -f |
uniq > '.github/actions/spelling/excludes.txt.temp' &&
mv '.github/actions/spelling/excludes.txt.temp' '.github/actions/spelling/excludes.txt'
}

comment_json=$(mktemp)
curl -L -s -S \
-H "Content-Type: application/json" \
"https://api.github.com/repos/aws/karpenter/issues/comments/1005028250" > "$comment_json"
comment_body=$(mktemp)
jq -r ".body // empty" "$comment_json" > $comment_body
rm $comment_json

patch_add=$(perl -e '$/=undef; $_=<>; if (m{Unrecognized words[^<]*</summary>\n*```\n*([^<]*)```\n*</details>$}m) { print "$1" } elsif (m{Unrecognized words[^<]*\n\n((?:\w.*\n)+)\n}m) { print "$1" };' < "$comment_body")

update_files
rm $comment_body
git add -u
If the flagged items do not appear to be text

If items relate to a ...

  • 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.

  • binary file.

    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).

@ellistarn ellistarn enabled auto-merge (squash) January 4, 2022 17:47
suket22
suket22 previously approved these changes Jan 4, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jan 4, 2022

@check-spelling-bot Report

🔴 Please review

See the files view or the action log for details.

Unrecognized words (472)
aaaaaaaaa
addon
adfdb
admissionregistration
aeccd
Affero
alertmanager
amazonvpc
amd
amdgpu
amiid
apic
apiextensions
apimachinery
apiobject
apiserver
APIV
appsv
args
asciicheck
authn
authz
Autoconfigure
autogenerated
autoprefixer
autoscaler
awscli
AWSEC
awserr
awslabs
awsmanpol
AWSTo
azs
bacd
baseurl
battletest
baz
bba
beorn
binpack
binpacking
blackfriday
blog
bmizerany
bootstrappers
bottlerocket
breadcrumb
brightgreen
browserconfig
btn
Burstable
bwagner
calcs
CAPI
Catmull
cce
cespare
cfn
cheney
clg
clientgoscheme
Clientset
cloudprovider
cloudprovidermetrics
cmp
cmw
cncf
cni
codebase
codegen
colocation
configmap
containerd
controllerruntime
corev
coveraged
coverpkg
coverprofile
crd
creativecommons
crmetrics
ctx
currentpath
daemonset
datasource
davec
davecgh
ddd
ddf
Debugf
deckarep
deepcopy
defragmentation
deletecopy
deprov
deprovisioned
deprovisioning
deserialize
Deserializer
dirname
dirs
disjoiner
distro
dkr
DNSIP
Dnz
docsy
dropdown
ebd
ece
eeeca
eksctl
EKv
elif
ellistarn
emitterc
emr
ENABLEGITINFO
eni
envtest
errcheck
errorlint
etarn
ETCD
evanphx
evenodd
evictable
expr
FAQs
farbox
fargate
favicon
fbbde
fcd
fddec
FFD
FFFFFF
fileno
filesystem
finalizer
finditer
fsnotify
fullname
fzipp
gci
gcp
gcr
getcwd
Ghods
github
gmail
gnet
gocache
gocyclo
GOFLAGS
gofuzz
golangci
goldmark
golicense
gomega
gomod
gomodules
google
googleapis
gosec
gpu
gpuapp
grafana
grep
groupcache
Groupless
gvk
Hashi
hashicorp
hashstructure
haspopup
healthz
heatmap
hebdf
highlighter
homepage
Hostnames
HPC
href
https
hvm
Hypervisor
iamidentitymapping
iamserviceaccount
ianlewis
ical
ico
iconx
ics
Idempotently
iface
imdario
IMDS
img
Impl
Infof
injectabletime
inkscape
instancegroup
instancetype
intstr
irsa
issuecomment
itemgetter
jbk
JJc
jjones
jmespath
jsonencode
jsonpatch
jsonpath
Jvd
karpenter
kcm
Kirill
kld
klog
KMGTPE
knative
knativeinjection
kube
kubebuilder
Kubecon
kubeconfig
kubectl
kubelet
kubernetes
labelledby
ldflags
libyaml
linenos
linewidth
linting
localhost
loglevel
logr
LRMHZ
lru
MAKECMDGOALS
markdownify
marvinpinto
matttproud
maxskew
mergo
metav
MGTPE
mikefarah
minheap
mitchellh
Mizerany
mkdir
mktemp
mmap
Mmpl
mozilla
msapplication
Mugp
multierr
mutatingwebhookconfigurations
myapp
mygpucontainer
mygpupod
myimage
Mylund
myprofile
namespaced
namespacedname
navbar
netural
nilset
nindent
njtran
Nlc
nodekubernetesioinstance
nodeselector
nolint
NONINFRINGEMENT
noopener
norwoodj
notkaperner
Npi
npm
numk
Nvb
nvidia
nyi
Ogier
oidc
ojsonpath
onboarded
onsi
openapi
OSX
outputdir
overwriter
packables
Pallinder
params
parserc
patrickmn
pdb
percentunit
permalink
piechart
pipefail
Placeholders
planetscale
Pluralizion
PODNAME
podspec
pointradius
Poppins
postcss
prateekgogia
prealloc
preemptible
printf
procfs
protobuf
protocolbuffers
provisionable
provisioners
ptr
pwd
pygments
qfdeof
qps
QZZQ
Rabenstein
randomdata
rbac
rdf
readerc
readme
readyz
relref
reqs
requeue
resourcesemantics
retriable
Retryer
retval
rgba
roadmap
russross
Saryerwinnie
scalability
scannerc
sdk
searchdirectory
searchpath
serializer
serviceaccount
sharedmain
Shortcode
should've
sigs
sitemap
sodipodi
soundcloud
sourceforge
spf
SPJ
src
SSMAPI
ssmiface
stacktrace
standalone
startinformers
stderr
stdin
stdout
stylecheck
subdir
subneta
subnetb
subnetc
subreconciler
subresource
substr
sudo
svg
sys
tabern
templating
TEMPOUT
terraform
testclient
testzone
Tgc
tilecolor
timepicker
timezone
todo
toolchain
tooltip
topdown
tparallel
tsbuckets
ttl
uber
uberwriter
ubuntu
uid
Uncomment
unconstrain
underutilized
Unescape
uninstall
uninstalling
unparam
unschedulable
updatecopy
urls
userdata
userguide
username
usr
utf
utilruntime
utils
Utuw
uuid
UVj
validatingwebhookconfigurations
vals
vcpu
Vec
versioned
virtualization
virtualized
vmimport
VRHVd
walkthrough
westzones
wiki
wikipedia
wildcards
WJRUF
workqueue
writerc
writerow
www
xargs
XAu
xaxis
xlarge
xlink
xmlns
xvda
xxhash
xyproto
yaml
yamlh
yamlprivateh
yaxes
yaxis
YBuckets
yml
Ymt
youtu
youtube
YXIu
yyyy
zapr
ZGVv
ZWJk
Available dictionaries could cover words not in the dictionary

cspell:cpp/cpp.txt (104293) covers 66 of them
cspell:html/html.txt (542) covers 9 of them
cspell:django/django.txt (2342) covers 9 of them
cspell:java/java.txt (33524) covers 8 of them
cspell:fullstack/fullstack.txt (181) covers 8 of them
cspell:css/css.txt (993) covers 7 of them
cspell:npm/npm.txt (671) covers 6 of them
cspell:filetypes/filetypes.txt (337) covers 6 of them
cspell:scala/scala.txt (2752) covers 5 of them
cspell:python/python.txt (364) covers 5 of them
cspell:lua/lua.txt (391) covers 4 of them
cspell:rust/rust.txt (112) covers 3 of them
cspell:ruby/ruby.txt (354) covers 2 of them
cspell:node/node.txt (9611) covers 2 of them
cspell:bash/bash-words.txt (22) covers 2 of them
cspell:csharp/csharp.txt (123) covers 1 of them
cspell:ada/ada.txt (72) covers 1 of them

Consider adding them using:

      with:
        extra_dictionaries:
          cspell:cpp/cpp.txt
          cspell:html/html.txt
          cspell:django/django.txt
          cspell:java/java.txt
          cspell:fullstack/fullstack.txt
          cspell:css/css.txt
          cspell:npm/npm.txt
          cspell:filetypes/filetypes.txt
          cspell:scala/scala.txt
          cspell:python/python.txt
          cspell:lua/lua.txt
          cspell:rust/rust.txt
          cspell:ruby/ruby.txt
          cspell:node/node.txt
          cspell:bash/bash-words.txt
          cspell:csharp/csharp.txt
          cspell:ada/ada.txt

To stop checking additional dictionaries, add:

      with:
        check_extra_dictionaries: ''
Some files were automatically ignored

These sample patterns would exclude them:

^\Qcharts/index.yaml\E$
^\Qcharts/karpenter-0.1.1.tgz\E$
^\Qcharts/karpenter-0.1.2.tgz\E$
^\Qcharts/karpenter-0.1.3.tgz\E$
^\Qcharts/karpenter-0.2.0.tgz\E$
^\Qcharts/karpenter-0.2.1.tgz\E$
^\Qcharts/karpenter-0.2.2.tgz\E$
^\Qcharts/karpenter-0.2.3.tgz\E$
^\Qcharts/karpenter-0.2.4.tgz\E$
^\Qcharts/karpenter-0.2.5.tgz\E$
^\Qcharts/karpenter-0.2.6.tgz\E$
^\Qcharts/karpenter-0.2.7.tgz\E$
^\Qcharts/karpenter-0.2.8.tgz\E$
^\Qcharts/karpenter-0.2.9.tgz\E$
^\Qcharts/karpenter-0.3.0.tgz\E$
^\Qcharts/karpenter-0.3.1.tgz\E$
^\Qcharts/karpenter-0.3.2.tgz\E$
^\Qcharts/karpenter-0.3.3.tgz\E$
^\Qcharts/karpenter-0.3.4.tgz\E$
^\Qcharts/karpenter-0.4.0.tgz\E$
^\Qcharts/karpenter-0.4.1.tgz\E$
^\Qcharts/karpenter-0.4.2.tgz\E$
^\Qcharts/karpenter-0.4.3.tgz\E$
^\Qcharts/karpenter-0.5.0.tgz\E$
^\Qcharts/karpenter-0.5.1.tgz\E$
^\Qcharts/karpenter-0.5.2.tgz\E$
^\Qcharts/karpenter-0.5.3.tgz\E$
^\Qgo.mod\E$
^\Qgo.sum\E$
^\Qtools/go.mod\E$
^\Qtools/go.sum\E$
^\Qwebsite/content/en/background.png\E$
^\Qwebsite/package-lock.json\E$
^\Qwebsite/static/banner.png\E$
^\Qwebsite/static/favicons/apple-touch-icon-180x180.png\E$
^\Qwebsite/static/favicons/favicon-16x16.png\E$
^\Qwebsite/static/favicons/favicon-32x32.png\E$
^\Qwebsite/static/favicons/pwa-192x192.png\E$
^\Qwebsite/static/favicons/pwa-512x512.png\E$
^\Qwebsite/static/favicons/tile150x150.png\E$
^\Qwebsite/static/favicons/tile310x150.png\E$
^\Qwebsite/static/favicons/tile310x310.png\E$
^\Qwebsite/static/favicons/tile70x70.png\E$
^\Qwebsite/static/full_logo.png\E$
^\Qwebsite/static/karpenter-overview.png\E$
^\Qwebsite/static/logo.png\E$
^\Qwebsite/static/termination-state-machine.png\E$

You should consider excluding directory paths (e.g. (?:^|/)vendor/), filenames (e.g. (?:^|/)yarn\.lock$), or file extensions (e.g. \.gz$)

You should consider adding them to:

.github/actions/spelling/excludes.txt

File matching is via Perl regular expressions.

To check these files, more of their words need to be in the dictionary than not. You can use patterns.txt to exclude portions, add items to the dictionary (e.g. by adding them to allow.txt), or fix typos.

Warnings (1)

See Warning descriptions for more information.

Warning Count
noisy-file 47
To accept these unrecognized words as correct, run the following commands

... in a clone of the [email protected]:ellistarn/karpenter.git repository
on the main branch:

update_files() {
perl -e '
my $new_expect_file=".github/actions/spelling/expect.txt";
use File::Path qw(make_path);
use File::Basename qw(dirname);
make_path (dirname($new_expect_file));
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"$patch_add"');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a)."-".$a cmp lc($b)."-".$b} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;
system("git", "add", $new_expect_file);
'
(cat '.github/actions/spelling/excludes.txt' - <<EOF
^\Qcharts/index.yaml\E$
^\Qcharts/karpenter-0.1.1.tgz\E$
^\Qcharts/karpenter-0.1.2.tgz\E$
^\Qcharts/karpenter-0.1.3.tgz\E$
^\Qcharts/karpenter-0.2.0.tgz\E$
^\Qcharts/karpenter-0.2.1.tgz\E$
^\Qcharts/karpenter-0.2.2.tgz\E$
^\Qcharts/karpenter-0.2.3.tgz\E$
^\Qcharts/karpenter-0.2.4.tgz\E$
^\Qcharts/karpenter-0.2.5.tgz\E$
^\Qcharts/karpenter-0.2.6.tgz\E$
^\Qcharts/karpenter-0.2.7.tgz\E$
^\Qcharts/karpenter-0.2.8.tgz\E$
^\Qcharts/karpenter-0.2.9.tgz\E$
^\Qcharts/karpenter-0.3.0.tgz\E$
^\Qcharts/karpenter-0.3.1.tgz\E$
^\Qcharts/karpenter-0.3.2.tgz\E$
^\Qcharts/karpenter-0.3.3.tgz\E$
^\Qcharts/karpenter-0.3.4.tgz\E$
^\Qcharts/karpenter-0.4.0.tgz\E$
^\Qcharts/karpenter-0.4.1.tgz\E$
^\Qcharts/karpenter-0.4.2.tgz\E$
^\Qcharts/karpenter-0.4.3.tgz\E$
^\Qcharts/karpenter-0.5.0.tgz\E$
^\Qcharts/karpenter-0.5.1.tgz\E$
^\Qcharts/karpenter-0.5.2.tgz\E$
^\Qcharts/karpenter-0.5.3.tgz\E$
^\Qgo.mod\E$
^\Qgo.sum\E$
^\Qtools/go.mod\E$
^\Qtools/go.sum\E$
^\Qwebsite/content/en/background.png\E$
^\Qwebsite/package-lock.json\E$
^\Qwebsite/static/banner.png\E$
^\Qwebsite/static/favicons/apple-touch-icon-180x180.png\E$
^\Qwebsite/static/favicons/favicon-16x16.png\E$
^\Qwebsite/static/favicons/favicon-32x32.png\E$
^\Qwebsite/static/favicons/pwa-192x192.png\E$
^\Qwebsite/static/favicons/pwa-512x512.png\E$
^\Qwebsite/static/favicons/tile150x150.png\E$
^\Qwebsite/static/favicons/tile310x150.png\E$
^\Qwebsite/static/favicons/tile310x310.png\E$
^\Qwebsite/static/favicons/tile70x70.png\E$
^\Qwebsite/static/full_logo.png\E$
^\Qwebsite/static/karpenter-overview.png\E$
^\Qwebsite/static/logo.png\E$
^\Qwebsite/static/termination-state-machine.png\E$
EOF
) |grep .|
sort -f |
uniq > '.github/actions/spelling/excludes.txt.temp' &&
mv '.github/actions/spelling/excludes.txt.temp' '.github/actions/spelling/excludes.txt'
}

comment_json=$(mktemp)
curl -L -s -S \
-H "Content-Type: application/json" \
"https://api.github.com/repos/aws/karpenter/issues/comments/1005078307" > "$comment_json"
comment_body=$(mktemp)
jq -r ".body // empty" "$comment_json" > $comment_body
rm $comment_json

patch_add=$(perl -e '$/=undef; $_=<>; if (m{Unrecognized words[^<]*</summary>\n*```\n*([^<]*)```\n*</details>$}m) { print "$1" } elsif (m{Unrecognized words[^<]*\n\n((?:\w.*\n)+)\n}m) { print "$1" };' < "$comment_body")

update_files
rm $comment_body
git add -u
If the flagged items do not appear to be text

If items relate to a ...

  • 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.

  • binary file.

    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).

@ellistarn ellistarn merged commit 90cf2b7 into aws:main Jan 4, 2022
@ellistarn ellistarn deleted the spelling branch January 4, 2022 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants