Skip to content

Commit

Permalink
Merge pull request #429 from ably/release/1.2.3
Browse files Browse the repository at this point in the history
Release/1.2.3
  • Loading branch information
QuintinWillison committed Oct 27, 2021
2 parents 96ead70 + 9f9c543 commit a36a6aa
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
9 changes: 8 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Change Log

## [v1.2.2](https://github.com/ably/ably-go/tree/v1.2.2) (2021-10-22))
## [v1.2.3](https://github.com/ably/ably-go/tree/v1.2.3) (2021-10-27)

Sorry for the noise but we made a mistake when we released version 1.2.2 of this library. :facepalm:

The `v1.2.2` tag was pushed against the wrong commit, meaning that the library was announcing itself as at version 1.2.1 to the Ably service.
This release (assuming we get the tag push right this time :stuck_out_tongue_winking_eye:) will correctly identify itself as version 1.2.3.

## [v1.2.2](https://github.com/ably/ably-go/tree/v1.2.2) (2021-10-22)

[Full Changelog](https://github.com/ably/ably-go/compare/v1.2.1...v1.2.2)

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -327,18 +327,18 @@ As of release 1.2.0, the following are not implemented and will be covered in fu

Starting with release 1.2, 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.2.2`
* Create a branch for the release, named like `release/1.2.3` (where `1.2.3` is the new version number)
* Replace all references of the current version number with the new version number and commit the changes
* Run [`github_changelog_generator`](https://github.com/github-changelog-generator/github-changelog-generator) to automate the update of the [CHANGELOG](./CHANGELOG.md). This may require some manual intervention, both in terms of how the command is run and how the change log file is modified. Your mileage may vary:
* The command you will need to run will look something like this: `github_changelog_generator -u ably -p ably-go --since-tag v1.2.2 --output delta.md`
* The command you will need to run will look something like this: `github_changelog_generator -u ably -p ably-go --since-tag v1.2.3 --output delta.md`
* Using the command above, `--output delta.md` writes changes made after `--since-tag` to a new file
* The contents of that new file (`delta.md`) then need to be manually inserted at the top of the `CHANGELOG.md`, changing the "Unreleased" heading and linking with the current version numbers
* Also ensure that the "Full Changelog" link points to the new version tag instead of the `HEAD`
* Commit this change: `git add CHANGELOG.md && git commit -m "Update change log."`
* Commit [CHANGELOG](./CHANGELOG.md)
* Make a PR against `main`
* Once the PR is approved, merge it into `main`
* Add a tag to the new `main` head commit and push to origin such as `git tag v1.2.2 && git push origin v1.2.2`
* Add a tag to the new `main` head commit and push to origin such as `git tag v1.2.3 && git push origin v1.2.3`

## Further information

Expand Down
2 changes: 1 addition & 1 deletion ably/proto_http.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const (
ablyVersionHeader = "X-Ably-Version"
ablyErrorCodeHeader = "X-Ably-Errorcode"
ablyErrorMessageHeader = "X-Ably-Errormessage"
libraryVersion = "1.2.2"
libraryVersion = "1.2.3"
libraryName = "go"
ablyVersion = "1.2"
ablyClientIDHeader = "X-Ably-ClientId"
Expand Down

0 comments on commit a36a6aa

Please sign in to comment.