-
Notifications
You must be signed in to change notification settings - Fork 313
Pull Request & Release Process
This project has two main branches:
-
master- New features, fixes, and other general enhancements should be based on master and merged back into master. -
stable- Stays in sync with the latest versioned release. Hotfixes (urgent fixes to released code) should be based on stable and merged back into stable (and then merged into master).
(This project follows a process similar to the git-flow model, but the development branch is master and the release branch is stable.)
Pull requests should be fully tested, checked for code consistency and appropriateness, confirmed by at least one other contributor, and totally ready to deploy before the are accepted. The master and stable branches should be ready for production at all times.
Make sure pull requests are accepted into the correct branch.
- features -> master (most pull requests)
- hotfixes -> stable
After a hotfix pull request is accepted, a new patch release should be created immediately.
A grunt task has been created to automate the release process. You can read the steps it performs in the Grunfile.js.
The task includes the following steps:
- Bump version
- Build dist
- Force add dist
- Commit changes
- Tag release
- Publish to npm
As well as a number of git commands needed in the process.
If there are any errors in the process, fix the issue and follow the remaining steps in the release task in the Gruntfile.
Once a hotfix has been accepted into the stable branch, checkout the stable branch and run grunt release:patch.
Run all tests on the master branch again. Then checkout stable, merge master into stable, and run grunt release:minor.
Same as minor, but run grunt release:major.