Skip to content

Commit

Permalink
Add releasing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
blgm committed May 19, 2020
1 parent e2ce1fd commit fe57286
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,7 @@ the need to create intermediate Go structures. Check out [the documentation](htt

JSONry started life in the [Cloud Foundry CLI](https://github.com/cloudfoundry/cli) project. It has been extracted so
that it can be used in other projects too.

More information:
- [License](./LICENSE)
- [Releasing](./RELEASING.md)
12 changes: 12 additions & 0 deletions RELEASING.md
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.

0 comments on commit fe57286

Please sign in to comment.