Skip to content

Commit 8c2e894

Browse files
committed
update doc
1 parent f64e367 commit 8c2e894

File tree

2 files changed

+48
-49
lines changed

2 files changed

+48
-49
lines changed

docs/contribute.md

Lines changed: 24 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,30 @@ In start of 2021, [more than 90% of the wordpress websites](https://wordpress.or
7272

7373
The plugin is tested under each of these WordPress versions: `5.6`, `5.5`, `5.4`, `5.3`, `5.2`, `5.1`, `5.0`, `4.9`.
7474

75+
#### Add support for a new WordPress version
76+
77+
This is a sheet cheet to help testing briefly the support:
78+
79+
```bash
80+
81+
# To install a specific version
82+
docker-compose up -d wordpress<X.X> crowdsec mysql redis memcached && docker-compose exec crowdsec cscli bouncers add wordpress-bouncer
83+
84+
# To display the captcha wall
85+
86+
docker-compose exec crowdsec cscli decisions add --ip ${DOCKER_HOST_IP} --duration 15m --type captcha
87+
88+
# To delete the image in order to rebuild it
89+
90+
docker-compose down && docker rmi wordpress-bouncer_wordpress<X.X>
91+
92+
# To debug inside the container
93+
94+
docker-compose run wordpress<X.X> bash
95+
```
96+
97+
> Note: The `DOCKER_HOST_IP` environnment variable is initialized via `source ./load-env-vars.sh`.
98+
7599
### Plugin debug mode VS production mode
76100

77101
The debug mode throw verbose errors. The production hide every error to let users navigate in every edge cases.
@@ -103,57 +127,8 @@ To destroy the vagrant instance:
103127
vagrant destroy
104128
```
105129

106-
#### Add support for a new WordPress version
107-
108-
This is a sheet cheet to help testing briefly the support:
109-
110-
```bash
111-
112-
# To install a specific version
113-
docker-compose up -d wordpress<X.X> crowdsec mysql redis memcached && docker-compose exec crowdsec cscli bouncers add wordpress-bouncer
114-
115-
# To display the captcha wall
116-
117-
docker-compose exec crowdsec cscli decisions add --ip ${DOCKER_HOST_IP} --duration 15m --type captcha
118-
119-
# To delete the image in order to rebuild it
120-
121-
docker-compose down && docker rmi wordpress-bouncer_wordpress<X.X>
122-
123-
# To debug inside the container
124-
125-
docker-compose run wordpress<X.X> bash
126-
```
127-
128-
> Note: The `DOCKER_HOST_IP` environnment variable is initialized via `source ./load-env-vars.sh`.
129-
130130
### Display the plugin logs
131131

132132
```bash
133133
tail -f logs/debug-*
134134
```
135-
136-
### New feature workflow
137-
138-
```bash
139-
git checkout -b <branch-name>
140-
git commit # as much as necessary.
141-
142-
# Rename branch if necessary
143-
git branch -m <new-name>
144-
git push origin :<old-name> && git push -u origin <new-name>
145-
146-
# Create PR
147-
gh pr create --fill
148-
```
149-
150-
> Note: after the merge, don't forget to delete to branch.
151-
152-
### New release workflow
153-
154-
```bash
155-
git checkout main && git pull && git co -
156-
git describe --tags `git rev-list --tags --max-count=1` # to verify what is the current tag
157-
export NEW_GIT_VERSION_WITHOUT_V_PREFIX= #...X.X.X
158-
./scripts/publish-release.sh
159-
```

docs/workflows.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
### New feature
2+
3+
```bash
4+
git checkout -b <branch-name>
5+
git commit # as much as necessary.
6+
7+
# Rename branch if necessary
8+
git branch -m <new-name>
9+
git push origin :<old-name> && git push -u origin <new-name>
10+
11+
# Create PR
12+
gh pr create --fill
13+
```
14+
15+
> Note: after the merge, don't forget to delete to branch.
16+
17+
### New release
18+
19+
```bash
20+
git checkout main && git pull && git co -
21+
git describe --tags `git rev-list --tags --max-count=1` # to verify what is the current tag
22+
export NEW_GIT_VERSION_WITHOUT_V_PREFIX= #...X.X.X
23+
./scripts/publish-release.sh
24+
```

0 commit comments

Comments
 (0)