Merge pull request #518 from ably/release/2.0.1

Release/2.0.1

Author: AndyTWF

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## [v2.0.1](https://github.com/ably/ably-python/tree/v2.0.1)
+
+[Full Changelog](https://github.com/ably/ably-python/compare/v2.0.0...v2.0.1)
+
+**Closed issues:**
+
+- Implement / Add tests for TM1,TM2,TM3 Message spec [\#516](https://github.com/ably/ably-python/issues/516)
+
+**Merged pull requests:**
+
+- \[SDK-3807\] Implement and test empty inner message fields [\#517](https://github.com/ably/ably-python/pull/517) ([sacOO7](https://github.com/sacOO7))
+
 ## [v2.0.0](https://github.com/ably/ably-python/tree/v2.0.0)
 
 **New ably-python realtime client**: This new release features our first ever python realtime client! Currently the realtime client only supports realtime message subscription. Check out the README for usage examples. There have been some minor breaking changes from the 1.2 version, please consult the [migration guide](https://github.com/ably/ably-python/blob/main/UPDATING.md) for instructions on how to upgrade to 2.0.

CONTRIBUTING.md

@@ -28,14 +28,19 @@ Releases should always be made through a release pull request (PR), which needs
 The release process must include the following steps:
 
 1. Ensure that all work intended for this release has landed to `main`
-2. Create a release branch named like `release/1.2.3`
+2. Create a release branch named like `release/2.0.1`
 3. Add a commit to bump the version number, updating [`pyproject.toml`](./pyproject.toml) and [`ably/__init__.py`](./ably/__init__.py)
-4. Add a commit to update the change log
-5. Push the release branch to GitHub
-6. Create a release PR (ensure you include an SDK Team Engineering Lead and the SDK Team Product Manager as reviewers) and gain approvals for it, then merge that to `main`
-7. From the `main` branch, run `poetry build && poetry publish` to build and upload this new package to PyPi
-8. Create a tag named like `v1.2.3` and push it to GitHub - e.g. `git tag v1.2.3 && git push origin v1.2.3`
-9. Create the release on GitHub including populating the release notes
+4. 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-python --since-tag v2.0.0 --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`
+5. Commit this change: `git add CHANGELOG.md && git commit -m "Update change log."`
+6. Push the release branch to GitHub
+7. Create a release PR (ensure you include an SDK Team Engineering Lead and the SDK Team Product Manager as reviewers) and gain approvals for it, then merge that to `main`
+8. From the `main` branch, run `poetry build && poetry publish` to build and upload this new package to PyPi
+9. Create a tag named like `v2.0.1` and push it to GitHub - e.g. `git tag v2.0.1 && git push origin v2.0.1`
+10. Create the release on GitHub including populating the release notes
 
 We tend to use [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator) to collate the information required for a change log update.
 Your mileage may vary, but it seems the most reliable method to invoke the generator is something like:

ably/__init__.py

@@ -15,4 +15,4 @@
 logger.addHandler(logging.NullHandler())
 
 api_version = '3'
-lib_version = '2.0.0'
+lib_version = '2.0.1'

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ably"
-version = "2.0.0"
+version = "2.0.1"
 description = "Python REST and Realtime client library SDK for Ably realtime messaging service"
 license = "Apache-2.0"
 authors = ["Ably <support@ably.com>"]