Permalink
Browse files

add a release check list

  • Loading branch information...
1 parent 7124dc4 commit 21b4143c18d47fdb6922765d8855b9538c851007 @remcoros remcoros committed Aug 31, 2015
Showing with 48 additions and 0 deletions.
  1. +48 −0 doc/release_check_list.txt
@@ -0,0 +1,48 @@
+# Release check-list for HearthstoneTracker
+
+## Terminology
+
+Branches:
+
+- release/*: Stable branch, source from latest published release
+- master: Unstable branch, latest source for next release
+
+Releases:
+
+ - Major: 1.x.x.x -> 2.x.x.x Do not use :p
+ - Minor: x.1.x.x -> x.2.x.x Increment manually when creating a new minor release
+ - Patch: x.x.1.x -> x.x.2.x Increment manually from a release branch
+ - Build: x.x.x.1 -> x.x.x.2 Incremented by the build server (AppVeyor)
+
+
+## Notes
+
+Major, minor and patch components of the version have to be increased manually (in appveyor.yml and Version.txt). Build number is generated by AppVeyor.
+
+Every minor version has their own branch, named 'release/<version>' (e.g. release/1.10)
+
+Patches (revisions) are applied on and released from their release branch.
+
+## Creating a minor release (and preparing next minor version)
+
+- Create release branch, e.g. 'release/1.10'
+- Switch to new release branch
+- Update version in appveyor.yml and Version.txt (remove -pre)
+- Update changelog
+- Commit changes
+- Push release branch to github
+- switch back to master and prepare next release
+- Update version in appveyor.yml and Version.txt
+- update changelog
+- Commit changes
+- Push master branch to github
+- Deploy to github from appveyor
+
+## Creating a patch release
+- make sure master branch is up to date with latest patches
+- make sure working dir is clean and on a 'release/*' branch.
+- Update version in appveyor.yml and Version.txt (update patch version)
+- Update changelog
+- Commit changes
+- Push release branch to github
+- Deploy to github from appveyor

0 comments on commit 21b4143

Please sign in to comment.