All changes that need to go out in a release must be merged into the develop branch.
Once all necessary changes are on develop, it's time to open a new Pull Request to merge develop into master. Set the base branch as master, set the compare branch as develop, and please title this Pull Request:
changes for the next release
IMPORTANT: The Pull Request can be merged only when the continuous integration checks pass.
The release script should only be run from the master branch. Checkout the master branch locally, pull in all latest changes, and confirm that the changes from the previous Pull Request made it into your local master branch.
Before we run the release script, we need to decide whether this is a major, minor, or patch release.
We're trying to follow SemVer, so please make sure you're familiar with the philosophy. Here's a few good resource:
Until we reach v1.0.0, please DO NOT release a major version. To run the release script, make sure you're inside the project root directory, and run one of the following commands:
npm run release:minor
npm run release:patch
Please take note of the release version; you'll see releasing v0.1.2 logged.
IMPORTANT: We're not done yet!
Once the release script finishes, it's time to open a new Pull Request to merge master into develop. Set the base branch as develop, set the compare branch as master, and please title this Pull Request:
changes from release {version}
... where {version} is the version that was just released (v0.1.2 from the example above).