From 2e66e4d5ec3ba42285329d4b722812860d0dc8a9 Mon Sep 17 00:00:00 2001 From: Erik Michelson Date: Wed, 4 Feb 2026 21:02:51 +0100 Subject: [PATCH] fix(docs): update release checklist Signed-off-by: Erik Michelson --- docs/content/dev/release_checklist.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/content/dev/release_checklist.md b/docs/content/dev/release_checklist.md index 674c13a8..d9c52bda 100644 --- a/docs/content/dev/release_checklist.md +++ b/docs/content/dev/release_checklist.md @@ -1,12 +1,14 @@ # Release Checklist: -To copy this checklist please go to [this link](https://github.com/hedgedoc/hedgedoc/blob/master/docs/content/dev/release_checklist.md). +To copy this checklist please go to [this link](https://github.com/hedgedoc/hedgedoc/raw/refs/heads/master/docs/content/dev/release_checklist.md). ## Preparations: - [ ] Create release PR(s) - [ ] In the main repo (actually only create a local branch to include all the fixes, additions and so on and only push and create a PR after testing) - [ ] Release PR in + - [ ] Update version in `.github/workflows/release.yml` + - [ ] Update version in `docker-compose.yml` - [ ] Release PR in - [ ] Security fixes (make sure all available undisclosed security fixes are merged) - [ ] Bump the version @@ -239,16 +241,17 @@ opengraph: } ``` - [ ] GitHub +- [ ] 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 You need to clone the [container repo](https://github.com/hedgedoc/container) and use the commands in the root there. -- [ ] debian +- [ ] debian ``` - docker buildx build -f debian/Dockerfile -t hedgedoc-local:1.x.y-debian . + docker buildx build -f debian/Dockerfile -t hedgedoc-local:1.x.y-debian . 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-debian ``` The server is then accessable via . The log should inlcude a line like @@ -266,7 +269,7 @@ You need to clone the [container repo](https://github.com/hedgedoc/container) an - [ ] alpine ``` - 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 ``` The server is then accessable via http://localhost:3000. The log should inlcude a line like @@ -287,12 +290,13 @@ You need to clone the [container repo](https://github.com/hedgedoc/container) an - [ ] Merge Release PR in main repo - [ ] Tag commit with `git tag 1.x.y` and push it - [ ] Create release in GitHub and upload tar ball to GitHub +- [ ] Update placeholders in Security Advisories (if they exist) - [ ] Publish Security Advisories (if they exist) - [ ] Merge Release PR in - Wait for the images to be available at -- [ ] Update website by running the ["deploy" workflow](https://github.com/hedgedoc/hedgedoc.github.io/actions?query=workflow%3A%22Deploy+to+github+actions+branch%22) in hedgedoc/hedgedoc.github.io +- [ ] Update website by running the ["deploy" workflow](https://github.com/hedgedoc/hedgedoc.github.io/actions/workflows/deploy.yml) in hedgedoc/hedgedoc.github.io - [ ] Update docs.hedgedoc.org by running the ["build" workflow](https://github.com/hedgedoc/docs.hedgedoc.org/actions/workflows/build.yml) - [ ] Merge Release PR in - - (optional) All people doing the release boost the post -- [ ] Share the good news in the Matrix-Chatroom + - (optional) All people doing the release boost the post +- [ ] Share the good news in the Matrix-Chatroom - [ ] Change this release checklist if necessary