Last active
December 23, 2016 14:47
-
-
Save justinvdm/f0dbd3ab3e877d45b9e2e2c1a4d552f4 to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
diff --git a/README.md b/README.md | |
index 40666c7..0a2c7d0 100644 | |
--- a/README.md | |
+++ b/README.md | |
@@ -35,7 +35,12 @@ Are added to the GitHub repo whenever a new tag is pushed. | |
## Release process | |
+`develop` is used for features currently in development, `master` for *production-ready* code. | |
+ | |
### Hotfix releases | |
+ | |
+**Note:** these release branches are merged into both `master` *and* `develop`, so if you are merging any branches into the hotfix branch, make sure it is based off of `master` and **not** `develop`. | |
+ | |
``` | |
git flow hotfix start <version> | |
# make some commits or merge in PR's branch if changes are in different branch | |
@@ -43,10 +48,31 @@ git flow hotfix start <version> | |
git flow hotfix finish -p <version> | |
``` | |
+Depending on how much `develop` and `master` have diverged, some merge conflicts may need to be resolved with `develop`. If that is the case, you'll need to manually complete the hotfix release process: | |
+ | |
+``` | |
+# resolve merge conflicts on develop | |
+git push origin develop | |
+git push origin master | |
+git push --tags | |
+git branch -d hotfix/<version> | |
+``` | |
+ | |
### Development releases | |
+ | |
A `dev` suffix should be used for dev releases, starting at `-dev`, followed by `-dev1`, `dev2`, etc. For example: `0.2.0-dev1`. | |
``` | |
# make relevant changes to `develop` branch (ideally via merging in feature branches) | |
./utils/dev-release.sh <version> | |
``` | |
+ | |
+### Production releases | |
+ | |
+**Note:** This process should only be followed when the current changes on `develop` are to be merged into `master` and considered the new **production-ready** code. | |
+ | |
+``` | |
+git flow release start <version> | |
+./utils/version.sh <version> | |
+git flow release finish -p <version> | |
+``` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment