Skip to content

Commit 12d0e01

Browse files
chayimchayim
authored
[3.x] Spellcheck as part of CI (#1354)
* spellcheck * spelling * fix bad commit * spelling * updating version of spellcheck action
1 parent af236dc commit 12d0e01

File tree

7 files changed

+87
-28
lines changed

7 files changed

+87
-28
lines changed

‎.github/spellcheck-settings.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
matrix:
2+
- name: Markdown
3+
expect_match: false
4+
apsell:
5+
lang: en
6+
d: en_US
7+
ignore-case: true
8+
dictionary:
9+
wordlists:
10+
- .github/wordlist.txt
11+
output: wordlist.dic
12+
pipeline:
13+
- pyspelling.filters.markdown:
14+
markdown_extensions:
15+
- markdown.extensions.extra:
16+
- pyspelling.filters.html:
17+
comments: false
18+
attributes:
19+
- alt
20+
ignores:
21+
- ':matches(code, pre)'
22+
- code
23+
- pre
24+
- blockquote
25+
- img
26+
sources:
27+
- 'README.md'
28+
- 'FAQ.md'
29+
- 'docs/**'

‎.github/wordlist.txt‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
ACLs
2+
Autoloading
3+
CAS
4+
Customizable
5+
ElastiCache
6+
FPM
7+
IANA
8+
Lua
9+
PSR
10+
Packagist
11+
PhpRedis
12+
Predis
13+
README
14+
Redis
15+
SHA
16+
SSL
17+
TCP
18+
TLS
19+
URI
20+
autoload
21+
autoloader
22+
autoloading
23+
backend
24+
backends
25+
behaviour
26+
customizable
27+
dataset
28+
de
29+
extensibility
30+
keyspace
31+
keyspaces
32+
localhost
33+
namespace
34+
pipelining
35+
pluggable
36+
rebalanced
37+
rebalancing
38+
redis
39+
runtime
40+
sharding
41+
stunnel
42+
variadic

‎.github/workflows/linters.yml‎

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ on:
77
branches:
88
- main
99
- v2.**
10-
- v3.**
1110
pull_request: null
1211

1312
permissions: {}
@@ -143,26 +142,3 @@ jobs:
143142
echo "CURRENT =${CURRENT}"
144143
echo "EXPECTED=${EXPECTED}"
145144
test "${CURRENT}" = "${EXPECTED}"
146-
147-
spelling:
148-
name: Spelling
149-
needs:
150-
- byte_level
151-
- syntax_errors
152-
runs-on: ubuntu-latest
153-
154-
steps:
155-
- name: Checkout repository
156-
uses: actions/checkout@v3
157-
158-
- name: Cache pip
159-
uses: actions/cache@v3
160-
with:
161-
path: ~/.cache/pip
162-
key: ${{ runner.os }}-pip-codespell
163-
164-
- name: Install codespell
165-
run: pip install --user 'codespell>=2.2'
166-
167-
- name: Search for misspellings
168-
run: $(python -m site --user-base)/bin/codespell

‎.github/workflows/spellcheck.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: spellcheck
2+
on:
3+
pull_request:
4+
jobs:
5+
check-spelling:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- name: Checkout
9+
uses: actions/checkout@v3
10+
- name: Check Spelling
11+
uses: rojopolis/[email protected]
12+
with:
13+
config_path: .github/spellcheck-settings.yml
14+
task_name: Markdown

‎.github/workflows/stack.yml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ on:
55
branches:
66
- main
77
- v2.**
8-
- v3.**
98
pull_request:
109

1110
jobs:

‎.github/workflows/tests.yml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ on:
55
branches:
66
- main
77
- v2.**
8-
- v3.**
98
pull_request:
109

1110
concurrency:

‎FAQ.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ but significantly reduces bytes sent over the network and Redis memory usage.
3333

3434
Without Relay, Predis will not serialize data and will never do that by default. The reason
3535
behind this decision is that serialization is usually something that developers prefer to
36-
customize depending on their needs and can not be easilygeneralized when using Redis because
36+
customize depending on their needs and can not be easily generalized when using Redis because
3737
of the many possible access patterns for your data. This does not mean that it is impossible
3838
to have such a feature since you can leverage the extensibility of this library to define
3939
your own serialization-aware commands. You can find more details about how to do that
@@ -90,7 +90,7 @@ Predis is fast enough when Redis is located on the same machine as PHP, more on
9090
[PhpRedis](https://github.com/phpredis/phpredis) (and Relay) perform significantly better when
9191
network I/O is involved, due to their ability to compress data by ~75%. Fewer bytes and received
9292
sent over the network [means faster operations](https://akalongman.medium.com/phpredis-vs-predis-comparison-on-real-production-data-a819b48cbadb),
93-
and potentially cost savings when network traffic isn't free (e.g. AWS Elasticache Inter-AZ transfer costs).
93+
and potentially cost savings when network traffic isn't free (e.g. AWS ElastiCache Inter-AZ transfer costs).
9494

9595
## Predis is a pure-PHP implementation: it can not be fast enough! ##
9696

0 commit comments

Comments
 (0)