Skip to content

Commit

Permalink
Merge pull request #223 from ably/release/1.2.5
Browse files Browse the repository at this point in the history
Release/1.2.5
  • Loading branch information
ben-xD committed Nov 15, 2021
2 parents c6413eb + 978b3ff commit acf168e
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 17 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# Changelog

## [1.2.5](https://github.com/ably/ably-flutter/tree/v1.2.5)

[Full Changelog](https://github.com/ably/ably-flutter/compare/v1.2.4...v1.2.5)

**Implemented enhancements:**

- Enhancement/push UI improvement for debugging [\#218](https://github.com/ably/ably-flutter/pull/218) ([ben-xD](https://github.com/ben-xD))

**Fixed bugs:**

- Handle error cases on iOS correctly, and simplify code [\#221](https://github.com/ably/ably-flutter/pull/221) ([ben-xD](https://github.com/ben-xD))
- Fix app crashing when app is not yet started on some devices [\#215](https://github.com/ably/ably-flutter/pull/215) ([ben-xD](https://github.com/ben-xD))

## [1.2.4](https://github.com/ably/ably-flutter/tree/v1.2.4)

[Full Changelog](https://github.com/ably/ably-flutter/compare/v1.2.3...v1.2.4)
Expand Down
25 changes: 13 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,21 +250,22 @@ 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
- Update the version in `pubspec.yaml`
- Update the version of ably-flutter used in the example app and test integration app `podfile.lock` files:
- Run `pod install` in `example/ios` and `test_integration/ios`, or run `pod install --project-directory=example/ios` and `pod install --project-directory=test_integration/ios
- Commit this
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. `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`, using `git tag v1.2.3`
11. Push the newly created tag to GitHub: `git push origin v1.2.3`
12. Create a release on GitHub following the [previous releases]((https://github.com/ably/ably-flutter/releases)) as examples.

To check that everything is looking sensible to the Flutter tools, without publishing, you can use:

flutter pub publish --dry-run
5. Check that everything is looking sensible to the Flutter tools without publishing by running: `flutter pub publish --dry-run`
6. Push the release branch to GitHub
7. Open a PR for the release against the release branch you just pushed
8. Gain approval(s) for the release PR from maintainer(s)
9. Land the release PR to `main`
10. Execute `flutter pub publish` from the root of this repository
11. Create a tag named like `v1.2.3`, using `git tag v1.2.3`
12. Push the newly created tag to GitHub: `git push origin v1.2.3`
13. Create a release on GitHub following the [previous releases]((https://github.com/ably/ably-flutter/releases)) as examples.

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:
Expand Down
4 changes: 2 additions & 2 deletions example/ios/Podfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ PODS:
- Ably (1.2.7):
- AblyDeltaCodec (= 1.3.2)
- msgpack (= 0.4.0)
- ably_flutter (1.2.4):
- ably_flutter (1.2.5):
- Ably (= 1.2.7)
- Flutter
- AblyDeltaCodec (1.3.2)
Expand Down Expand Up @@ -45,7 +45,7 @@ EXTERNAL SOURCES:

SPEC CHECKSUMS:
Ably: f627c0c2e4489785b74d33d2c1287edeb9c6a7be
ably_flutter: 7ff0cf10711d0ef59a1aca69205b0aabd3175344
ably_flutter: 43b5908539837dd5020a07a3ed7a6133a3275fa2
AblyDeltaCodec: 783d017270de70bbbc0a84e4235297b225d33636
device_info_plus: e5c5da33f982a436e103237c0c85f9031142abed
Flutter: 50d75fe2f02b26cc09d224853bb45737f8b3214a
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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.4
version: 1.2.5
repository: https://github.com/ably/ably-flutter

environment:
Expand Down
4 changes: 2 additions & 2 deletions test_integration/ios/Podfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ PODS:
- Ably (1.2.7):
- AblyDeltaCodec (= 1.3.2)
- msgpack (= 0.4.0)
- ably_flutter (1.2.4):
- ably_flutter (1.2.5):
- Ably (= 1.2.7)
- Flutter
- AblyDeltaCodec (1.3.2)
Expand All @@ -27,7 +27,7 @@ EXTERNAL SOURCES:

SPEC CHECKSUMS:
Ably: f627c0c2e4489785b74d33d2c1287edeb9c6a7be
ably_flutter: 7ff0cf10711d0ef59a1aca69205b0aabd3175344
ably_flutter: 43b5908539837dd5020a07a3ed7a6133a3275fa2
AblyDeltaCodec: 783d017270de70bbbc0a84e4235297b225d33636
Flutter: 50d75fe2f02b26cc09d224853bb45737f8b3214a
msgpack: c85f6251873059738472ae136951cec5f30f3251
Expand Down

0 comments on commit acf168e

Please sign in to comment.