Add development process assumptions and move step to pull develop updates into master

Curtis Gedak 2018-04-11 13:44:36 -06:00
parent 89cf6a3efb
commit 8f93e0efb8

@ -7,10 +7,17 @@ more experience is gained.
Assumptions
-----------
- **N-1** (*0.6.0*) is the current production release
- **N** (*0.7.0*) is about to be released
- **N+1** (*0.8.0*) is a release in the future
### Development Process
- All enhancements are made to the **develop** branch
- The **master** branch represents the current production release
### Version Numbers
- **N-1** is the current production release (e.g., *0.6.0*)
- **N** is the upcoming version about to be released (e.g., *0.7.0*)
- **N+1** is a release at some unknown point in the future (e.g., *0.8.0*)
Steps
-----
@ -26,7 +33,7 @@ Steps
- Close current project release milestone **N-1**.
- Ensure all issues and PRs are completed for milestone **N**, or
- Ensure all issues and pull requests are completed for milestone **N**, or
move to a different milestone.
- Create future release milestone **N+1**.
@ -39,23 +46,17 @@ Steps
- Contact translation members about upcoming release in **1 week**?
- Incorporate translation updates
4. ADD DEVELOPMENT CHANGES TO MASTER BRANCH
- Merge develop branch into master branch.
git checkout master
git merge develop
5. PREPARE CHANGELOG
4. PREPARE CHANGELOG
- Generate changelog.
git checkout develop
github_changelog_generator -u olivierkes -p manuskript \
--token {MyChangelogGithubToken}
- Edit `CHANGELOG.md` to adjust for release number.
6. PREPARE SOURCE CODE FOR PRODUCTION RELEASE
5. PREPARE SOURCE CODE FOR PRODUCTION RELEASE
- Update `manuskript/version.py` version number for production release
@ -67,6 +68,17 @@ Steps
git add manuskript/version.py CHANGELOG.md
git commit -m "========== manuskript-x.y.z =========="
- Push updates to the **develop** branch
git push
6. ADD DEVELOPMENT CHANGES TO MASTER BRANCH FOR OFFICIAL RELEASE
- Merge develop branch into master branch.
git checkout master
git merge develop
- Stamp production version label on git repository
git tag -a X.Y.Z -m "manuskript-x.y.z release"