From 1c2f0cb2efcf6980e366a70f4b07270d2f28ec3c Mon Sep 17 00:00:00 2001 From: Ben Butterworth <24711048+ben-xD@users.noreply.github.com> Date: Mon, 16 Aug 2021 07:29:46 +0100 Subject: [PATCH 1/4] Bump version (not following semantic versioning): a patch release" is created to keep v1.2 which is the Ably protocol version (this may change in the future) --- example/pubspec.lock | 2 +- pubspec.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/example/pubspec.lock b/example/pubspec.lock index 84559ac88..eee489088 100644 --- a/example/pubspec.lock +++ b/example/pubspec.lock @@ -7,7 +7,7 @@ packages: path: ".." relative: true source: path - version: "1.2.0" + version: "1.2.1" async: dependency: transitive description: diff --git a/pubspec.yaml b/pubspec.yaml index 76cfc4ca4..056d2a002 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: ably_flutter description: A wrapper around Ably's Cocoa and Java client library SDKs, providing iOS and Android support. -version: 1.2.0 +version: 1.2.1 repository: https://github.com/ably/ably-flutter environment: From ea04e3c5dd6f2c597d0026d854603950aaa837ba Mon Sep 17 00:00:00 2001 From: Ben Butterworth <24711048+ben-xD@users.noreply.github.com> Date: Mon, 16 Aug 2021 07:43:24 +0100 Subject: [PATCH 2/4] Add 1.2.1 changelog and add more detail to release instructions --- CHANGELOG.md | 28 ++++++++++++++++++++++++++-- CONTRIBUTING.md | 4 +++- 2 files changed, 29 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b17125e2f..0b19d09b7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,32 @@ # Changelog -## [v1.2.0](https://github.com/ably/ably-flutter/tree/v1.2.0) +## [1.2.1](https://github.com/ably/ably-flutter/tree/1.2.1) -[Full Changelog](https://github.com/ably/ably-flutter/compare/1.2.0-preview.2...v1.2.0) +[Full Changelog](https://github.com/ably/ably-flutter/compare/1.2.0...1.2.1) + +**Implemented enhancements:** + +- Migrate to null safety [\#82](https://github.com/ably/ably-flutter/issues/82) + +**Closed issues:** + +- Investigate libraries that can help leverage our push implementation [\#142](https://github.com/ably/ably-flutter/issues/142) +- Could not find method coreLibraryDesugaring\(\) for arguments [\#130](https://github.com/ably/ably-flutter/issues/130) +- Create code snippets for homepage \(flutter\) [\#124](https://github.com/ably/ably-flutter/issues/124) +- Make this SDK ready for the first non-preview release [\#102](https://github.com/ably/ably-flutter/issues/102) +- Activate and getting Push Notifications [\#54](https://github.com/ably/ably-flutter/issues/54) + +**Merged pull requests:** + +- Bump ws from 5.2.2 to 5.2.3 in /example/test\_harness [\#145](https://github.com/ably/ably-flutter/pull/145) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Skip 1 failing test, fix 1 failing test and schedule tests on main twice a day [\#144](https://github.com/ably/ably-flutter/pull/144) ([ben-xD](https://github.com/ben-xD)) +- Refactor large files into 1 file per class [\#138](https://github.com/ably/ably-flutter/pull/138) ([ben-xD](https://github.com/ben-xD)) +- Add instructions for M1 macs and fixing ruby fatal error for example apps [\#137](https://github.com/ably/ably-flutter/pull/137) ([ben-xD](https://github.com/ben-xD)) +- Migrate to null-safety [\#136](https://github.com/ably/ably-flutter/pull/136) ([tiholic](https://github.com/tiholic)) + +## [v1.2.0](https://github.com/ably/ably-flutter/tree/1.2.0) + +[Full Changelog](https://github.com/ably/ably-flutter/compare/1.2.0-preview.2...1.2.0) **Merged pull requests:** diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eda645d8a..3b9541929 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -199,7 +199,9 @@ 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` 3. Add a commit to bump the version number -4. Add a commit to update the change log +4. Add a commit to update the change log. + - Autogenerate the changelog contents by running `github_changelog_generator -u ably -p ably-flutter --since-tag 1.2.0 --output delta.md` and manually copying the relevant contents from `delta.md` into `CHANGELOG.md` + - Make sure to replace `HEAD` in the autogenerated URL's with the version tag you will create (e.g. `1.2.1`). 5. Push the release branch to GitHub 6. Open a PR for the release against the release branch you just pushed 7. Gain approval(s) for the release PR from maintainer(s) From 84728502d5f8496127ca95c763c738942664328a Mon Sep 17 00:00:00 2001 From: Ben Butterworth <24711048+ben-xD@users.noreply.github.com> Date: Mon, 16 Aug 2021 07:47:03 +0100 Subject: [PATCH 3/4] Use release tags with `v` prefix (e.g. v1.2.1 instead of 1.2.1 as recommended by Github) --- CHANGELOG.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0b19d09b7..688e3ac64 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,8 @@ # Changelog -## [1.2.1](https://github.com/ably/ably-flutter/tree/1.2.1) +## [v1.2.1](https://github.com/ably/ably-flutter/tree/v1.2.1) -[Full Changelog](https://github.com/ably/ably-flutter/compare/1.2.0...1.2.1) +[Full Changelog](https://github.com/ably/ably-flutter/compare/v1.2.0...v1.2.1) **Implemented enhancements:** @@ -24,9 +24,9 @@ - Add instructions for M1 macs and fixing ruby fatal error for example apps [\#137](https://github.com/ably/ably-flutter/pull/137) ([ben-xD](https://github.com/ben-xD)) - Migrate to null-safety [\#136](https://github.com/ably/ably-flutter/pull/136) ([tiholic](https://github.com/tiholic)) -## [v1.2.0](https://github.com/ably/ably-flutter/tree/1.2.0) +## [v1.2.0](https://github.com/ably/ably-flutter/tree/v1.2.0) -[Full Changelog](https://github.com/ably/ably-flutter/compare/1.2.0-preview.2...1.2.0) +[Full Changelog](https://github.com/ably/ably-flutter/compare/1.2.0-preview.2...v1.2.0) **Merged pull requests:** From 29ecfaff75394466a39cd3526c8c1c7b507c583a Mon Sep 17 00:00:00 2001 From: Ben Butterworth <24711048+ben-xD@users.noreply.github.com> Date: Mon, 16 Aug 2021 09:21:46 +0100 Subject: [PATCH 4/4] Add more detail in release process (creating and pushing git tag) --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3b9541929..5375917c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -201,13 +201,14 @@ The release process must include the following steps: 3. Add a commit to bump the version number 4. Add a commit to update the change log. - Autogenerate the changelog contents by running `github_changelog_generator -u ably -p ably-flutter --since-tag 1.2.0 --output delta.md` and manually copying the relevant contents from `delta.md` into `CHANGELOG.md` - - Make sure to replace `HEAD` in the autogenerated URL's with the version tag you will create (e.g. `1.2.1`). + - Make sure to replace `HEAD` in the autogenerated URL's with the version tag you will create (e.g. `v1.2.1`). 5. Push the release branch to GitHub 6. Open a PR for the release against the release branch you just pushed 7. Gain approval(s) for the release PR from maintainer(s) 8. Land the release PR to `main` 9. Execute `flutter pub publish` from the root of this repository -10. Create a tag named like `v1.2.3` and push it to GitHub +10. Create a tag named like `v1.2.3`, using `git tag v1.2.3` +11. Push the newly created tag to GitHub: `git push origin v1.2.3` To check that everything is looking sensible to the Flutter tools, without publishing, you can use: