Skip to content

Commit

Permalink
Merge pull request #714 from ably/release/1.2.9
Browse files Browse the repository at this point in the history
Release/1.2.9
  • Loading branch information
QuintinWillison authored Sep 13, 2021
2 parents df037f9 + 6075946 commit 2b8e3c7
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 9 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Change Log

## [v1.2.9](https://github.com/ably/ably-java/tree/v1.2.9)

[Full Changelog](https://github.com/ably/ably-java/compare/v1.2.8...v1.2.9)

**Fixed bugs:**

- IllegalArgumentException: No enum constant io.ably.lib.http.HttpAuth.Type.BASİC [\#711](https://github.com/ably/ably-java/issues/711)
- ProGuard warnings emitted by Android build against 1.1.6 [\#529](https://github.com/ably/ably-java/issues/529)

**Merged pull requests:**

- Fix incorrect parsing of HTTP auth type for some locales [\#712](https://github.com/ably/ably-java/pull/712) ([QuintinWillison](https://github.com/QuintinWillison))
- Suppressed warning in ProGuard [\#709](https://github.com/ably/ably-java/pull/709) ([martin-morek](https://github.com/martin-morek))

## [v1.2.8](https://github.com/ably/ably-java/tree/v1.2.8)

[Full Changelog](https://github.com/ably/ably-java/compare/v1.2.7...v1.2.8)
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,15 +172,15 @@ in order to get end-to-end FCM notifications working.

This library uses [semantic versioning](http://semver.org/). For each release, the following needs to be done:

1. Create a branch for the release, named like `release/1.2.7`
2. Replace all references of the current version number with the new version number (check this file [README.md](./README.md) and [common.gradle](./common.gradle)) and commit the changes
1. Create a branch for the release, named like `release/1.2.4` (where `1.2.4` is what you're releasing, being the new version)
2. Replace all references of the current version number with the new version number (check the [README.md](./README.md) and [common.gradle](./common.gradle)) and commit the changes
3. Run [`github_changelog_generator`](https://github.com/skywinder/Github-Changelog-Generator) to update the [CHANGELOG](./CHANGELOG.md):
* This might work: `github_changelog_generator -u ably -p ably-java --header-label="# Changelog" --release-branch=release/1.2.7 --future-release=v1.2.7`
* But your mileage may vary as it can error. Perhaps more reliable is something like: `github_changelog_generator -u ably -p ably-java --since-tag v1.2.6 --output delta.md` and then manually merge the delta contents in to the main change log
* This might work: `github_changelog_generator -u ably -p ably-java --header-label="# Changelog" --release-branch=release/1.2.4 --future-release=v1.2.4`
* But your mileage may vary as it can error. Perhaps more reliable is something like: `github_changelog_generator -u ably -p ably-java --since-tag v1.2.3 --output delta.md` and then manually merge the delta contents in to the main change log (where `1.2.3` is the preceding release)
4. Commit [CHANGELOG](./CHANGELOG.md)
5. Make a PR against `main`
6. Once the PR is approved, merge it into `main`
7. Add a tag and push to origin - e.g.: `git tag v1.2.7 && git push origin v1.2.7`
7. Add a tag and push to origin - e.g.: `git tag v1.2.4 && git push origin v1.2.4`
8. Create the release on Github including populating the release notes
9. Assemble and Upload ([see below](#publishing-to-maven-central) for details) - but the overall order to follow is:
1. Comment out local `repository` lines in the two `maven.gradle` files temporarily (this is horrible but is [to be fixed soon](https://github.com/ably/ably-java/issues/566))
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Include the library by adding an `implementation` reference to `dependencies` bl
For [Java](https://mvnrepository.com/artifact/io.ably/ably-java/latest):

```
implementation 'io.ably:ably-java:1.2.8'
implementation 'io.ably:ably-java:1.2.9'
```

For [Android](https://mvnrepository.com/artifact/io.ably/ably-android/latest):

```
implementation 'io.ably:ably-android:1.2.8'
implementation 'io.ably:ably-android:1.2.9'
```

The library is hosted on [Maven Central](https://mvnrepository.com/repos/central), so you need to ensure that the repository is referenced also; IDEs will typically include this by default:
Expand Down
2 changes: 1 addition & 1 deletion common.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ repositories {
}

group = 'io.ably'
version = '1.2.8'
version = '1.2.9'
description = 'Ably java client library'

tasks.withType(Javadoc) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ public void realtime_websocket_param_test() {
* Defaults.ABLY_AGENT_PARAM, as ultimately the request param has been derived from those values.
*/
assertEquals("Verify correct lib version", requestParameters.get("agent"),
Collections.singletonList("ably-java/1.2.8 jre/" + System.getProperty("java.version")));
Collections.singletonList("ably-java/1.2.9 jre/" + System.getProperty("java.version")));

/* Spec RTN2a */
assertEquals("Verify correct format", requestParameters.get("format"),
Expand Down

0 comments on commit 2b8e3c7

Please sign in to comment.