-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
A JSONry release is a tagged git sha and a GitHub release. To cut a release: | ||
|
||
1. Create a tag with a version number, e.g. `git tag 'v1.3.0'` | ||
2. Push the tag, e.g. `git push --tags` | ||
3. Use `git log --pretty=format:'- %s [%h]' HEAD...vX.X.X` to list all the commits since the last release | ||
- Categorize the changes into | ||
- Breaking Changes (requires a major version) | ||
- New Features (minor version) | ||
- Fixes (fix version) | ||
- Maintenance (which in general can be omitted) | ||
4. Create a new [GitHub release](https://help.github.com/articles/creating-releases/) with the version number as the tag (e.g. `v1.3.0`). | ||
5. Use the changes generated in a previous step (3) as a basis for the release notes. |