Skip to content

Commit

Permalink
Update README for version references
Browse files Browse the repository at this point in the history
  • Loading branch information
paddybyers committed Feb 6, 2019
1 parent b472e5c commit 630a634
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,11 +270,11 @@ As the library is actively developed couple of features are not there yet:

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

* Create a branch for the release, named like `release-1.0.6`
* Create a branch for the release, named like `release-1.1.2`
* Replace all references of the current version number with the new version number and commit the changes
* Run [`github_changelog_generator`](https://github.com/skywinder/Github-Changelog-Generator) to update the [CHANGELOG](./CHANGELOG.md): `github_changelog_generator -u ably -p ably-go --header-label="# Changelog" --release-branch=release-1.0.6 --future-release=v1.0.6`
* Run [`github_changelog_generator`](https://github.com/skywinder/Github-Changelog-Generator) to update the [CHANGELOG](./CHANGELOG.md): `github_changelog_generator -u ably -p ably-go --header-label="# Changelog" --release-branch=release-1.1.2 --future-release=v1.1.2`
* Commit [CHANGELOG](./CHANGELOG.md)
* Add a tag and push to origin such as `git tag v1.0.6; git push origin v1.0.6`
* Add a tag and push to origin such as `git tag v1.1.2; git push origin v1.1.2`
* Make a PR against `develop`
* Once the PR is approved, merge it into `develop`
* Fast-forward the master branch: `git checkout master && git merge --ff-only develop && git push origin master`
Expand All @@ -300,4 +300,4 @@ Because this package uses `internal` packages, all fork development has to happe

## License

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

0 comments on commit 630a634

Please sign in to comment.