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

Spellcheck as part of CI #3492

Merged
merged 6 commits into from
Jan 2, 2024
Merged
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
28 changes: 28 additions & 0 deletions .github/spellcheck-settings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
matrix:
- name: Markdown
expect_match: false
apsell:
lang: en
d: en_US
ignore-case: true
dictionary:
wordlists:
- .github/wordlist.txt
output: wordlist.dic
pipeline:
- pyspelling.filters.markdown:
markdown_extensions:
- markdown.extensions.extra:
- pyspelling.filters.html:
comments: false
attributes:
- alt
ignores:
- ':matches(code, pre)'
- code
- pre
- blockquote
- img
sources:
- '*.md'
- 'docs/**'
308 changes: 308 additions & 0 deletions .github/wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,308 @@
!!!Spelling check failed!!!
APM
ARGV
BFCommands
BitOP
BitPosParams
BuilderFactory
CFCommands
CMSCommands
CircuitBreaker
ClientKillParams
ClusterNode
ClusterNodes
ClusterPipeline
ClusterPubSub
ConnectionPool
CoreCommands
EVAL
EVALSHA
Failback
Failover
GSON
GenericObjectPool
GenericObjectPoolConfig
GeoAddParams
GeoRadiusParam
GeoRadiusStoreParam
GeoUnit
GraphCommands
Grokzen's
HostAndPort
HostnameVerifier
INCR
IOError
Instrumentations
JDK
JSONArray
JSONCommands
Jaeger
Javadocs
Jedis
JedisCluster
JedisPool
JedisPooled
JedisShardInfo
ListPosition
Ludovico
Magnocavallo
McCurdy
NOSCRIPT
NUMPAT
NUMPT
NUMSUB
OSS
OpenCensus
OpenTelemetry
OpenTracing
Otel
POJO
POJOs
PubSub
Queable
READONLY
RediSearch
RediSearchCommands
RedisBloom
RedisCluster
RedisClusterCommands
RedisClusterException
RedisClusters
RedisGraph
RedisInstrumentor
RedisJSON
RedisTimeSeries
SHA
SSLParameters
SSLSocketFactory
SearchCommands
SentinelCommands
SentinelConnectionPool
ShardInfo
Sharded
Solovyov
SortingParams
SpanKind
Specfiying
StatusCode
StreamEntryID
TCP
TOPKCommands
TimeSeriesCommands
URI
UnblockType
UnifiedJedis
Uptrace
ValueError
WATCHed
WatchError
XTrimParams
ZAddParams
ZParams
aclDelUser
api
approximateLength
arg
args
async
asyncio
autoclass
automodule
backoff
bdb
behaviour
bitcount
bitop
bitpos
bool
boolean
booleans
bysource
charset
clientId
clientKill
clientUnblock
clusterCountKeysInSlot
clusterKeySlot
configs
consumerName
consumername
cumbersome
dbIndex
dbSize
decr
decrBy
del
destKey
dev
dstKey
dstkey
eg
exc
expireAt
failback
failover
faoliver
firstName
firsttimersonly
fo
genindex
geoadd
georadiusByMemberStore
georadiusStore
getbit
gmail
groupname
hdel
hexists
hincrBy
hincrByFloat
hiredis
hlen
hset
hsetnx
hstrlen
http
idx
iff
incr
incrBy
incrByFloat
ini
json
keyslot
keyspace
keysvalues
kwarg
lastName
lastsave
linsert
linters
llen
localhost
lpush
lpushx
lrem
lua
makeapullrequest
maxLen
maxdepth
maya
memberCoordinateMap
mget
microservice
microservices
millisecondsTimestamp
mset
msetnx
multikey
mykey
newkey
nonatomic
observability
oldkey
opentelemetry
oss
param
params
performant
pexpire
pexpireAt
pfadd
pfcount
pmessage
png
pre
psubscribe
pttl
pubsub
punsubscribe
py
pypi
quickstart
readonly
readwrite
redis
redismodules
reimplemented
reinitialization
renamenx
replicaof
repo
rpush
rpushx
runtime
sadd
scard
scoreMembers
sdiffstore
sedrik
setbit
setnx
setrange
sinterstore
sismember
slowlogLen
smove
sortingParameters
srcKey
srcKeys
srckey
ssl
storeParam
str
strlen
stunnel
subcommands
sunionstore
thevalueofmykey
timeseries
toctree
topk
tox
triaging
ttl
txt
un
unblockType
unicode
unixTime
unlink
untyped
url
virtualenv
waitReplicas
whenver
www
xack
xdel
xgroupDelConsumer
xgroupDestroy
xlen
xtrim
zadd
zcard
zcount
zdiffStore
zincrby
zinterstore
zlexcount
zpopmax
zpopmin
zrandmember
zrandmemberWithScores
zrange
zrangeByLex
zrangeByScore
zrangeByScoreWithScores
zrangeWithScores
zrem
zremrangeByLex
zremrangeByRank
zremrangeByScore
zrevrange
zrevrangeByLex
zrevrangeByScore
zrevrangeByScoreWithScores
zrevrangeWithScores
zunionstore
14 changes: 14 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: spellcheck
on:
pull_request:
jobs:
check-spelling:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Check Spelling
uses: rojopolis/[email protected]
with:
config_path: .github/spellcheck-settings.yml
task_name: Markdown
Loading