Skip to content

Commit

Permalink
Add release notes to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
mattheworiordan committed Mar 7, 2017
1 parent 590bbd9 commit 40dbe55
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,15 @@ To see what has changed in recent versions of Bundler, see the [CHANGELOG](CHANG
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Release notes

This library uses [semantic versioning](http://semver.org/). For each release, the following needs to be done:

* Update the version number in [version.rb](./lib/ably/version.rb) and commit the change.
* Run [`github_changelog_generator`](https://github.com/skywinder/Github-Changelog-Generator) to automate the update of the [CHANGELOG](./CHANGELOG.md). Once the `CHANGELOG` update has completed, manually change the `Unreleased` heading and link with the current version number such as `v1.0.0`. Also ensure that the `Full Changelog` link points to the new version tag instead of the `HEAD`. Commit this change.
* Add a tag and push to origin such as `git tag v1.0.0 && git push origin v1.0.0`
* Run `rake release` to publish the gem to [Rubygems](http://www.rubydoc.info/gems/ably)

## License

Copyright (c) 2016 Ably Real-time Ltd, Licensed under the Apache License, Version 2.0. Refer to [LICENSE](LICENSE) for the license terms.

0 comments on commit 40dbe55

Please sign in to comment.