Merge pull request #427 from ably/release/1.2.6

Release 1.2.6

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Change Log
 
+## [v1.2.6](https://github.com/ably/ably-ruby/tree/v1.2.6)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.2.5...v1.2.6)
+
+**Implemented enhancements:**
+
+- [ably-ruby][no-connection-serial] Implement connection resume/recover [\#393](https://github.com/ably/ably-ruby/issues/393)
+- [ably-ruby][no-connection-serial] Implement missing internal presence [\#392](https://github.com/ably/ably-ruby/issues/392)
+- [ably-ruby][no-connection-serial] Implement code + tests for no-connection-serial [\#378](https://github.com/ably/ably-ruby/issues/378)
+
+**Closed issues:**
+
+- Remove unimplemented push activation methods [\#417](https://github.com/ably/ably-ruby/issues/417)
+- Failing Test - updates attach\_serial [\#415](https://github.com/ably/ably-ruby/issues/415)
+- Failing Test - retrieves two pages of messages before channel was attached [\#414](https://github.com/ably/ably-ruby/issues/414)
+- [ably-ruby] Fix failing tests [\#394](https://github.com/ably/ably-ruby/issues/394)
+
 ## [v1.2.5](https://github.com/ably/ably-ruby/tree/v1.2.5)
 
 This contains an important fix for a TLS certificate validation bug which prevented the library from being able to use Realtime fallback hosts.

README.md

@@ -97,6 +97,14 @@ client.connection.on do |state_change|
 end
 ```
 
+Retrieve connection id, state etc
+
+```ruby
+connection_id = client.connection.id
+state = client.connection.state
+recovery_key = client.connection.create_recovery_key # https://ably.com/docs/connect/states?q=recovery#connection-state-recover-options
+```
+
 ### Subscribing to a channel
 
 Given a channel is created as follows:
@@ -331,9 +339,18 @@ To see what has changed in recent versions of Bundler, see the [CHANGELOG](CHANG
 
 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`. Ideally, run `rake doc:spec` to generate a new [spec file](./SPEC.md). Then commit these changes.
-* Add a tag and push to origin such as `git tag v1.0.0 && git push origin v1.0.0`
-* Visit [https://github.com/ably/ably-ruby/tags](https://github.com/ably/ably-ruby/tags) and `Add release notes` for the release including links to the changelog entry.
-* Run `rake release` to publish the gem to [Rubygems](https://rubygems.org/gems/ably)
-* Release the [REST-only library `ably-ruby-rest`](https://github.com/ably/ably-ruby-rest#release-process)
+1. Create a branch for the release, named like `release/1.2.3` (where `1.2.3` is the new version number)
+2. Update the version number in [version.rb](./lib/ably/version.rb) and commit the change.
+3. 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-ruby --since-tag v1.2.3 --output delta.md --token $GITHUB_TOKEN_WITH_REPO_ACCESS`. Generate token [here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token).
+   - 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`
+4. Commit this change: `git add CHANGELOG.md && git commit -m "Update change log."`
+5. Ideally, run `rake doc:spec` to generate a new [spec file](./SPEC.md). Then commit these changes.
+6. Make a PR against `main`. Once the PR is approved, merge it into `main`.
+7. Add a tag to the new `main` head commit and push to origin such as `git tag v1.0.3 && git push origin v1.0.3`.
+8. Visit [https://github.com/ably/ably-ruby/tags](https://github.com/ably/ably-ruby/tags) and `Add release notes` for the release including links to the changelog entry.
+9. Run `rake release` to publish the gem to [Rubygems](https://rubygems.org/gems/ably).
+10. Release the [REST-only library `ably-ruby-rest`](https://github.com/ably/ably-ruby-rest#release-process).
+11. Create the entry on the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/)).