diff --git a/docs/content/dev/release-checklist.md b/docs/content/dev/release-checklist.md new file mode 100644 index 000000000..a8768dfc4 --- /dev/null +++ b/docs/content/dev/release-checklist.md @@ -0,0 +1,31 @@ +# Release Checklist + +- [ ] Security fixes (make sure all available undisclosed security fixes are merged) +- [ ] Bump the version + - [ ] docs/content/dev/openapi.yml + - version number image + - [ ] docs/content/setup/manual-setup.md + - `git clone` branch + - `git checkout` branch + - [ ] package.json + - `version` + - [ ] public/docs/release-notes.md + - version + - date + - text +- [ ] Update docker-compose in the docs +- [ ] Make sure `yarn.lock` is up to date +- [ ] Make sure translations are up to date +- [ ] Exclude `.github folder` +- [ ] Write release notes + - [ ] General description + - [ ] Things requiring special action beside updating the software + - [ ] New features + - [ ] Bug fixes + - [ ] Enhancements + - [ ] Add all contributors +- [ ] Run the tests described in the release test document (internal) +- [ ] Upload tar ball to github and add a release tag +- [ ] Update container images +- [ ] 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 +