diff --git a/CHANGELOG.md b/CHANGELOG.md index 1858b502..7677c61e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,12 +1,31 @@ # Change Log +## [v1.2.1](https://github.com/ably/ably-go/tree/v1.2.1) (2021-08-09) + +[Full Changelog](https://github.com/ably/ably-go/compare/v1.2.0...v1.2.1) + +**Implemented enhancements:** + +- Need a migration guide for users going from 1.1.5 to 1.2.0 [\#361](https://github.com/ably/ably-go/issues/361) +- Changelog and release tag [\#48](https://github.com/ably/ably-go/issues/48) + +**Merged pull requests:** + +- Update generated files [\#371](https://github.com/ably/ably-go/pull/371) ([lmars](https://github.com/lmars)) +- Don't set message encoding for valid utf-8 string data [\#370](https://github.com/ably/ably-go/pull/370) ([lmars](https://github.com/lmars)) +- Export the ablytest package [\#366](https://github.com/ably/ably-go/pull/366) ([tcard](https://github.com/tcard)) +- Migration guide 1.1.5 to 1.2.0 [\#364](https://github.com/ably/ably-go/pull/364) ([QuintinWillison](https://github.com/QuintinWillison)) +- Update README.md [\#362](https://github.com/ably/ably-go/pull/362) ([AndyNicks](https://github.com/AndyNicks)) +- RTC8a: client-requested reauthorization while CONNECTED \(to `main` branch\) [\#357](https://github.com/ably/ably-go/pull/357) ([tcard](https://github.com/tcard)) +- RTC8a: client-requested reauthorization while CONNECTED [\#336](https://github.com/ably/ably-go/pull/336) ([tcard](https://github.com/tcard)) + ## [v1.2.0](https://github.com/ably/ably-go/tree/v1.2.0) (2021-07-09) Version 1.2.0 is out of pre-release! -[**Full Changelog since v1.1.5**](https://github.com/ably/ably-go/compare/v1.1.5...v.1.2.0) +[**Full Changelog since v1.1.5**](https://github.com/ably/ably-go/compare/v1.1.5...v1.2.0) -[Full Changelog since v1.2.0-apipreview.6](https://github.com/ably/ably-go/compare/v1.2.0-apipreview.6...v.1.2.0) +[Full Changelog since v1.2.0-apipreview.6](https://github.com/ably/ably-go/compare/v1.2.0-apipreview.6...v1.2.0) **Implemented enhancements:** @@ -443,4 +462,4 @@ Version 1.2.0 is out of pre-release! -\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* \ No newline at end of file +\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* diff --git a/README.md b/README.md index 0bec7c8f..e393e77e 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ A Go client library for [https://ably.com/](https://ably.com/), the realtime mes ~ $ go get -u github.com/ably/ably-go/ably ``` -## Breaking API Changes in Version 1.2.0 +## Breaking API Changes in Version 1.2.x -Please see our [Upgrade / Migration Guide](UPDATING.md) for notes on changes you need to make to your code to update it to use the new API introduced by version 1.2.0. +Please see our [Upgrade / Migration Guide](UPDATING.md) for notes on changes you need to make to your code to update it to use the new API introduced by version 1.2.x. Users updating from version 1.1.5 of this library will note that there are significant breaking changes to the API. Our [current approach to versioning](https://ably.com/documentation/client-lib-development-guide/versioning) is not compliant with semantic versioning, which is why these changes are breaking despite presenting only a change in the `minor` component of the version number. @@ -391,10 +391,10 @@ 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.1` +* Create a branch for the release, named like `release/1.2.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/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.1.4 --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.1 --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` @@ -402,7 +402,7 @@ Starting with release 1.2, this library uses [semantic versioning](http://semver * 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.1 && git push origin v1.2.1` +* 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` ## Further information diff --git a/ably/proto_http.go b/ably/proto_http.go index a47149a5..e1b830d4 100644 --- a/ably/proto_http.go +++ b/ably/proto_http.go @@ -6,7 +6,7 @@ const ( ablyLibHeader = "X-Ably-Lib" ablyErrorCodeHeader = "X-Ably-Errorcode" ablyErrorMessageHeader = "X-Ably-Errormessage" - libraryVersion = "1.2.0" + libraryVersion = "1.2.1" libraryName = "go" libraryString = libraryName + "-" + libraryVersion ablyVersion = "1.2" diff --git a/ably/realtime_conn_spec_test.go b/ably/realtime_conn_spec_test.go index 6e5bc507..fe96a32f 100644 --- a/ably/realtime_conn_spec_test.go +++ b/ably/realtime_conn_spec_test.go @@ -107,7 +107,7 @@ func Test_RTN2_WebsocketQueryParams(t *testing.T) { t.Parallel() requestParams := setup() lib := requestParams["lib"] - assertDeepEquals(t, []string{"go-1.2.0"}, lib) + assertDeepEquals(t, []string{"go-1.2.1"}, lib) }) }