sa6anw/hedgedoc-hedgeagent
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs(release-checklist): add improvments from the 1.11.0 release

Browse Source 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares
2026-06-19 00:10:59 +02:00
committed by Erik Michelson
parent f115b2d084
commit e0351704c9
1 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/content/dev/release_checklist.md
View File

@@ -82,6 +82,8 @@ Use this tar ball to test the following things:
- [ ] User registration works - [ ] User registration works
- [ ] User login works - [ ] User login works
- [ ] User self-deletion works (notes are deleted as well) - [ ] User self-deletion works (notes are deleted as well)
- [ ] User data export works
- [ ] Rate-limiting for basic user/password (`curl -X POST --data email=test@example.com%40password=123456 http://localhost:3000/login`)
### Notes ### Notes
@@ -187,11 +189,12 @@ opengraph:
--- ---
``` ```
### GDPR features ### Slides
- [ ] Delete account works <http://localhost:3000/slide-example>
- [ ] When account is deleted, verify notes are gone as well
- [ ] Data export works - [ ] Make sure the slide mode works as intended
- [ ] Speaker view is toggled by `S`
### Auth ### Auth
@@ -245,11 +248,12 @@ opengraph:
``` ```
- [ ] GitHub - [ ] GitHub
- [ ] GitLab - [ ] GitLab
- [ ] Rate-limiting for basic user/password (try to login with e.g. test@example.com and invalid password about 10 to 15 times in a row -> you should receive a message "Too many requests" at some point)
### Docker images ### Docker images
You need to clone the [container repo](https://github.com/hedgedoc/container) and use the commands in the root there. 1. You should push the release branch to Github
2. You need to clone the [container repo](https://github.com/hedgedoc/container) and use the commands in the root there.
3. Edit `debian/Dockerfile` and `alpine/Dockerfile` to use the release branch instead of the `master` branch for building
- [ ] debian - [ ] debian
@@ -275,7 +279,7 @@ You need to clone the [container repo](https://github.com/hedgedoc/container) an
docker buildx build -f alpine/Dockerfile -t hedgedoc-local:1.x.y-alpine . docker buildx build -f alpine/Dockerfile -t hedgedoc-local:1.x.y-alpine .
docker run --rm -p 3000:3000 -e CMD_DOMAIN="localhost" -e CMD_URL_ADDPORT=true -e "CMD_DB_URL=sqlite://:memory:" hedgedoc-local:1.x.y-alpine docker run --rm -p 3000:3000 -e CMD_DOMAIN="localhost" -e CMD_URL_ADDPORT=true -e "CMD_DB_URL=sqlite://:memory:" hedgedoc-local:1.x.y-alpine
``` ```
The server is then accessable via http://localhost:3000. The log should inlcude a line like The server is then accessable via <http://localhost:3000>. The log should inlcude a line like
``` ```
127.0.0.1 - - [06/Dec/2025:16:17:51 +0000] "GET /_health HTTP/1.1" 200 14 "-" "hedgedoc-container-healthcheck/1.2" 127.0.0.1 - - [06/Dec/2025:16:17:51 +0000] "GET /_health HTTP/1.1" 200 14 "-" "hedgedoc-container-healthcheck/1.2"
@@ -302,4 +306,5 @@ You need to clone the [container repo](https://github.com/hedgedoc/container) an
- [ ] Merge Release PR in <https://github.com/hedgedoc/social-media> - [ ] Merge Release PR in <https://github.com/hedgedoc/social-media>
- (optional) All people doing the release boost the post - (optional) All people doing the release boost the post
- [ ] Share the good news in the Matrix-Chatroom - [ ] Share the good news in the Matrix-Chatroom
- [ ] Request CVEs (if applicable)
- [ ] Change this release checklist if necessary - [ ] Change this release checklist if necessary