From f024f396bf2bc1dc6998f31e489b742d90635265 Mon Sep 17 00:00:00 2001 From: link2xt Date: Tue, 16 May 2023 22:50:48 +0000 Subject: [PATCH] docs: document release process in RELEASE.md --- RELEASE.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 000000000..8a93946b4 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,18 @@ +# Releasing a new version of DeltaChat core + +For example, to release version 1.116.0 of the core, do the following steps. + +1. Resolve all [blocker issues](https://github.com/deltachat/deltachat-core-rust/labels/blocker). + +2. Update the changelog: `git cliff --unreleased --tag 1.116.0 --prepend CHANGELOG.md` or `git cliff -u -t 1.116.0 -p CHANGELOG.md`. + +3. Update the version by running `scripts/set_core_version.py 1.116.0`. + +4. Commit the changes as `chore(release): prepare for 1.116.0`. + Optionally, use a separate branch like `prep-1.116.0` for this commit and open a PR for review. + +5. Tag the release: `git tag -a v1.116.0`. + +6. Push the release tag: `git push origin v1.116.0`. + +7. Create a GitHub release: `gh release create v1.116.0 -n ''`.