From 757d303802bb50a79a479e75347ce036c338d11c Mon Sep 17 00:00:00 2001 From: "Jonathan \"Duke\" Leto" Date: Thu, 3 Nov 2022 03:54:55 -0700 Subject: [PATCH] Add release doc --- doc/release-process.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 doc/release-process.md diff --git a/doc/release-process.md b/doc/release-process.md new file mode 100644 index 0000000..69a019a --- /dev/null +++ b/doc/release-process.md @@ -0,0 +1,33 @@ +# SilentDragonLite Release Process + +## High-Level Philosophy + +Beware of making high-risk changes too close to a new release, because they will not get as much testing as they should. Don't merge large branches which haven't undergone lots of testing just before a release. + +It is best to keep doc/relnotes/README.md up to date as changes and bug fixes are made. It's more work to summarize all changes and bugfixes just before the release. + +## Check for changes on master that should be on dev + +See https://git.hush.is/hush/hush3/src/branch/master/doc/release-process.md#check-for-changes-on-master-that-should-be-on-dev , there is no sense repeating the exact same thing here. + +SD+SDL very often has merge conflicts in generated translation files, because QT embeds line numbers in XML. +Read how to deal with them efficiently here: https://git.hush.is/hush/SilentDragon/src/branch/dev/doc/release-process.md#dealing-with-merge-conflicts + +## Git Issues + +Look for Git issues that should be fixed in the next release: https://git.hush.is/hush/SilentDragonLite/issues Especially low-risk and simple things and like documentation changes and improvements to error messages. Take note that changing strings in the source code, such as adding a new string or changing an existing one, will affect translations. + +## Translations + +... + +``` +# update generated translation data +./build.sh linguist +git commit -am "update translations" +git push +``` + +## Release process + +...