diff --git a/.github/actions/spell-check/excludes.txt b/.github/actions/spell-check/excludes.txt new file mode 100644 index 0000000000000..bd0a61d60c08f --- /dev/null +++ b/.github/actions/spell-check/excludes.txt @@ -0,0 +1,10 @@ +^LICENSE$ +^pkg/chunkenc/testdata/testdata\.go$ +^pkg/logql/expr\.y\.go$ +\.ico$ +\.pgp$ +\.png$ +(?:^|/)go\.mod$ +(?:^|/)go\.sum$ +(?:^|/)vendor/ +^\.github/actions/spell-check/ diff --git a/.github/actions/spell-check/patterns.txt b/.github/actions/spell-check/patterns.txt new file mode 100644 index 0000000000000..6e23ba39a8e5f --- /dev/null +++ b/.github/actions/spell-check/patterns.txt @@ -0,0 +1,8 @@ +data:[a-zA-Z=;,/0-9+]+ +https://(?:(?:www\.|)youtube\.com|youtu.be)/[-a-zA-Z0-9?&=]* +(?: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 + +# This misspelling was fixed and exists to document its previous existence +defaul_validity diff --git a/.github/actions/spell-check/whitelist.txt b/.github/actions/spell-check/whitelist.txt new file mode 100644 index 0000000000000..bb358c70f78e9 --- /dev/null +++ b/.github/actions/spell-check/whitelist.txt @@ -0,0 +1,1230 @@ +aad +abcdefghijklmnopqrstuvwxyz +acdc +ackd +acl +adamjohnson +addgroup +adduser +Adil +adityacs +aeaa +aeaee +afiskon +Agg +aggr +aggregators +alecthomas +alertmanager +alexis +allanhung +Allocs +allthingsdistributed +amazondynamodb +amd +anarcher +angelbarrera +annotationname +annotationpresent +ANSIC +api +APIKEY +apipromlabel +apipromlabelnamevalues +apiprompush +apipromquery +apipromtail +apiserver +apk +appendf +Appname +apps +archivable +argparse +args +armhf +armv +astmapper +atleast +Atoi +attr +authn +autocomplete +autodetect +autogenerated +autolabels +autoscale +autoscaled +autoscaling +autoupdate +awoods +aws +bacb +backend +backport +bak +bastjan +batchsize +batchwait +baz +bazbar +bazz +bbolt +bboreham +bc +bdc +benchmem +benjaminhuo +beorn +beornf +bfa +bfe +bfoo +bigtable +billimek +binfmt +binop +bip +Bjob +blackbox +blahblahblah +blerrrgh +blog +blokey +bloki +bmatcuk +boltdb +botk +bottomk +Bouchaara +Braack +briangann +brightgreen +bth +btn +buf +bufconn +bufio +bufnet +bugfix +Bugfixes +buildkit +buildmode +bumms +busybox +byt +Bytesize +byteslice +bzr +bzrignore +cacheability +candlerb +castagnoli +cbff +ccbba +cce +cea +Ceph +CEPJRLQNL +cfb +cfba +cfg +cgo +chancez +changelog +charset +checkstyle +cheksum +cheney +chk +chmod +chown +chunkenc +ci +cidr +circleci +ckgc +cksum +cleanfn +clickyotomy +clientv +cloudbuild +clusterrole +clusterrolebinding +cn +CNCF +cnt +codecov +codecoverage +codehilite +codesome +commandline +compat +concat +config +configmap +conntrack +consistentreads +containerd +CONTAINERROOT +cooldown +coreos +cortexmetrics +cortexproject +couchdb +Cov +covermode +coverprofile +cpuprofile +cqfr +cri +css +csv +ctrox +ctx +cutil +cw +Cyclomatic +cyril +cyriltovena +daemonset +daixiang +dalance +dangoodman +danieldabate +datacenter +datasize +datasource +datastructure +datetime +davecgh +davkal +dawidmalina +dba +dbe +ddd +dde +ddf +ddfe +ddff +DDOS +deadcode +debian +decbuf +decbytes +ded +dedupe +deduped +deduplicate +deduplicated +deduplicating +DEFAULTCERT +DEFAULTKEY +deprioritized +deps +developerguide +devops +devopsdays +df +dfc +dgzlopes +dh +dirname +dirs +dlv +dns +dockerfile +DOCTYPE +doki +dottedmag +doublestar +dropdown +DSL +dst +dtennander +dustin +dynamodb +eb +eca +ecf +edbef +edbf +edbfd +eebe +eec +eeea +EFK +ei +ekarlso +ekeih +EKS +Elasticsearch +elliott +emailing +EMERG +encbuf +endef +Endian +endif +endswith +ent +entrypoint +enum +Envar +envsubst +eot +Equalf +Eraac +errcheck +errexit +errfc +Errflag +Errorf +erwinvaneyk +esac +etcd +euo +ev +evalsocket +Eventuallyf +everytime +Exca +excon +exe +executables +exkey +expfmt +expr +exprdefault +exprg +exprj +exprlex +exprn +exprnewstate +exprnt +exprp +exprpt +exprrcvr +exprstack +exprstate +exprtoken +extlbs +extldflags +extr +fallthrough +Fargate +Fatalf +Fatalln +fatih +favicon +fba +fbfe +fcfdb +Fconsul +fd +fda +fdbb +FDDS +fdff +fef +fifocache +Fileglob +filelist +filepath +filesystem +filetarget +filetargetmanager +filetype +findstring +Firefox +fitzoh +FIXME +fizzbuzz +flagext +flagset +flouthoc +fluentbit +fluentd +fmahnke +fnv +foldl +fontawesome +foob +foobuzz +foofoofoo +fooo +forcepathstyle +foreach +fosdem +Fprint +Fprintf +Fprintln +Fratto +fredgate +freebsd +freedesktop +frombits +frontend +frotend +fsnotify +fstab +fswatch +fullname +func +FZjg +gc +gcc +gcflags +gcov +gcp +gemfile +gemspec +geowa +Getenv +gethostname +getopts +gettext +GFR +gh +ghr +github +githubusercontent +gitignore +glyphicons +gnet +GNg +gnupg +goarch +goarm +GOCACHE +goconst +Godeps +godoc +goenv +GOFLAGS +gofmt +GOGC +gogoproto +gogoslick +GOHOSTOS +goimport +Gokit +golang +golangci +golint +GOMOD +google +googleapis +googlegroups +GOPATH +gopkg +GOPROXY +goreleaser +goreportcard +goroutine +gosimple +gotchas +gotpl +Goups +Goutham +gouthamve +govet +goyacc +gpg +grafana +grafanasaur +grep +grok +grpc +grpcclient +grrrragh +gsub +GTB +gw +gz +gzip +gzipped +hardcoded +hashicorp +hashmod +hdr +headblock +headchunk +healthcheck +hgignore +hj +homepage +Horkyze +hostlog +hostname +hotkeys +hpcloud +href +hsh +hsraju +html +htpasswd +http +httpclienttimeout +httpfs +httpgrpc +httptest +Hzvk +iam +iana +ico +identd +idx +ietf +ifc +ifeq +ifneq +ikeeip +Imagepull +img +impl +inclusivity +Indexmapkey +Indexmapvalue +ineffassign +influxdata +ingesters +initialising +inlining +inmemory +inotify +INSTANCEID +INSTANCEURL +interators +interoperability +Intn +Inuse +ioutil +ip +irake +irb +Iseconds +istream +Itoa +itr +jaegertracing +jb +Jdf +jgehrcke +jh +jm +jmes +jmespath +johncming +jojohappy +jonaskello +journalctl +journald +journaltarget +jq +jquery +jrfg +json +JSONEq +jsonfile +jsonfilelog +jsoniter +jsonl +jsonnet +jsonnetfmt +jsonpath +jsontag +jstaffans +jwt +kailwallin +kaltschmidt +kausal +kbd +kccna +keepalive +keey +keyring +keyspace +keyval +Kibana +Kitazawa +klauspost +klog +kmsg +ks +ksonnet +kube +kubectl +kubelet +kubernetes +kuberneteslbs +KVs +kvstore +labeldrop +labelkeep +labelmap +labeln +labelname +labelnamevalues +labelpresent +labelquery +labelset +labelvalue +lastn +lazychunks +lbl +lchk +Lck +ldconfig +ldflags +len +Lenmapkey +Lenmapvalue +lexer +lhs +libc +libcap +libjemalloc +libprotobuf +libsonnet +libsystemd +lifecycle +lifecycler +lifecyler +linecheck +linewidth +linux +linuxdocker +linuxkit +literl +lmq +localhost +logcli +logdir +logdriver +logentry +logfmt +loghttp +loglevel +logline +logmetrics +logpath +logproto +logql +logutil +lokiapipromtail +lokiapiv +lokiflag +lokiindex +lokil +lokiproject +lokiutil +lookback +lreq +lru +lss +lstore +Lucene +lukipro +Lusitaniae +lval +lvl +lvp +lvparts +lz +Mahnke +mailto +maintainership +makocchi +mapkey +mapstruct +mapstructure +mapvalue +marcosnils +martinbaillie +mattmendick +maxbackoff +maxes +maxretries +maxt +maxwait +MBAq +MBs +Mbytes +megacheck +memberlist +memcache +memcached +memchunk +memprofile +merr +metadata +metrictank +mgmt +Mgoogle +microservices +Microsoft +middleware +milli +minbackoff +mindfl +minhdanh +mitchellh +mixin +Mjqu +mkdir +Mmp +mnt +Modf +modtimevfs +monotek +Mozilla +msgid +msglen +mtail +mtime +mtric +mul +multiarch +multiline +multitenant +musl +mutex +mware +mwitkow +mybucket +myproject +mysql +mytag +namespace +nano +navbar +Navern +NEQ +Nerrs +netgo +newfake +newval +nginx +nicr +nindent +nodename +nodeport +nodeselector +nofollow +nohighlight +noindex +Nolabels +nolint +nomatch +NONINFRINGEMENT +Nop +NOPASSWD +nopush +noreply +notail +notdir +notempty +notimportant +notjson +notmissing +Notpresent +nounset +Nowf +nsswitch +Nyma +Nyr +nyys +OAuth +obitech +octetcounting +oddlittlebird +ojson +okfc +olivierboudet +omfwd +omitempty +ondemand +oniguruma +oo +oobar +OOM +Openstack +opensuse +opentracing +OPTIND +osarch +oss +OSTYPE +otgrpc +otlog +OTr +outmessage +Overlappingchunks +owen +Panicf +Panicln +parallelizable +params +passphrase +passthrough +passwd +pastatopf +pathpkg +patsubst +pb +pdf +pem +percentunit +Pgo +PGP +pid +pierrec +pipefail +Pivotto's +PKey +placeholders +PLog +plugin +png +podname +podsecuritypolicy +pointradius +poki +popd +popen +postgres +ppref +pprof +pracucci +Prebuilt +predef +prefetch +preload +Prepopulate +printf +Println +priorityqueue +probot +procid +promauto +promhttp +promql +promtail +protobuf +protoc +protoio +protos +pruneinterval +psp +pstibrany +Ptr +pushd +pushgateway +putrasattvika +PUx +pv +pwd +px +py +pytz +Qg +Qk +qps +qry +queryrange +querystats +querystring +quux +raintank +Rakefile +randomise +ratelimits +rb +rbac +rcvd +RDONLY +rdr +Readdir +readdirent +readline +readme +readonly +realtime +reconnections +recv +recvd +redis +refactor +referer +regex +regexexpression +regexp +reimplementation +remotetimeout +replaceme +REPONAME +requeue +resps +resync +retryable +returncode +rez +rfc +rfratto +rgb +rgba +rhs +rlimit +RLock +rmi +robshep +roidelapluie +Rolebinding +rootfs +rootfsimage +roundtrip +rpc +rspec +rsplit +rsteneteg +rsyslog +Rubo +rubocop +rubygems +ruh +RUnlock +runns +runtimeconfig +rv +rw +rx +sandeepsukhani +sandlis +scalability +sched +SCollins +screenshots +sdjournal +sdk +seccomp +secring +semver +sendfile +seriesquery +serilog +serverww +serviceaccount +servs +setcap +sfoo +shaikatz +shane +shardable +shokada +Shota +shurcoo +Shutdownable +SIGINT +SIGTERM +simplecov +simplication +sleleko +slideshare +smh +smhdwy +sntpc +socio +somefolder +somethigelse +sortkeys +sosp +sourced +soz +spanlogger +speakerdeck +splitby +Sprintf +Sprintln +src +srv +ssh +ssl +standalone +statefulset +Statenames +Statname +statuscode +stddev +stderr +stdin +stdout +stdtime +stdvar +stgs +Stin +strconv +stretchr +strftime +strptime +structcheck +structs +stylesheet +subdir +Subexp +subfolder +Submatch +subparser +subqueries +subrecord +subseconds +subservice +substr +sudo +sudoers +Sukhani +supermajority +SUSE +svg +svn +svs +swp +symlink +syncer +Sys +syscall +sysctl +syslog +syslogparser +systemd +SZ +tablemanager +tabwriter +tada +taggerdate +takanabe +talham +targetgroup +tarokkk +tbody +tcnksm +TCO +tcp +td +temal +templating +terjesannum +testdata +testgood +testjob +testmetric +testsize +testsubdir +testutil +testval +textbox +textparse +tgz +thead +timedelta +timeoutz +timepicker +timeseries +timestampe +timezone +tj +tls +TLSCA +tmp +tmpl +tmproj +tms +tns +todo +tok +tokname +Toknames +TOKSTART +tomgs +toml +tomwilkie +tonistiigi +tooltip +topk +tostring +tourea +tovena +tpl +tpw +tripperware +trunc +tsdb +tt +ttf +ttl +twilkie +ty +typeahead +typecheck +Typef +typings +tzdata +tzdb +ub +uber +ubuntu +ufffdz +uhhhhhhh +uid +uint +ul +ulimit +Uniary +unicode +uninstall +Uninstalling +uniq +unk +unmarshal +unmarshaler +unmarshaling +unmarshalling +unparam +unrecognised +Unregister +unshardable +Untag +uploader +upto +uptodate +uri +url +urlencode +urlencoded +useragent +userid +username +usp +usr +utc +utcnow +utf +utils +uvarint +Uvx +uzz +validator +varcheck +varint +varlibdockercontainers +varlog +vec +veeramachaneni +vendored +vendoring +versioning +vf +vfsdata +vfsgen +vishesh +VPREFIX +vscode +vtereso +vx +vy +waaayyyyy +wallclock +wapmorgan +wardbekker +wassan +weavework +websites +websocket +wget +whitelist +whoami +whothey +wiki +wikipedia +Wildcards +Wilkie's +wiretype +woff +woodsaj +WOOOOO +WORKDIR +workflow +worl +worr +wphan +Wrapf +writeback +wss +wws +www +xa +xaa +xab +xac +xad +xae +xaf +xargs +xaxis +xb +xba +xbb +xbc +xbd +xbe +xbf +xca +xcb +xcc +xcd +xce +xcf +xda +xdb +xdc +xdd +xde +xdf +xe +xea +xeb +xec +xee +xef +xf +xfa +xfb +xfc +xfd +xfe +xff +XFux +XPOST +xvf +xz +yacc +yajl +yamale +yaml +yamllint +yaxes +yaxis +YBky +yml +yourhost +ytools +Yupp +yyfmt +yys +Ze +zendern +zhangjianweibj +zshrc +ZYIQ +zypper +zz diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml new file mode 100644 index 0000000000000..3710dc1a5a43b --- /dev/null +++ b/.github/workflows/spelling.yml @@ -0,0 +1,21 @@ +name: Spell checking +on: + push: + branches: + - "**" + tags-ignore: + - "**" + +jobs: + build: + name: Spell checking + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2.1.0 + with: + fetch-depth: 5 + - uses: check-spelling/check-spelling@0.0.15-alpha + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + bucket: .github/actions + project: spell-check