Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme and change list #638

Merged
merged 5 commits into from
Jun 29, 2021
Merged

Update readme and change list #638

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fb140bb
Update README
vbuberen Jun 26, 2021
6113a46
Update CHANGELOG
vbuberen Jun 26, 2021
1088a8e
Fix typo
vbuberen Jun 26, 2021
f170b2f
Update date of 3.5.0 release
vbuberen Jun 28, 2021
6ab0438
Minor punctuation updates
vbuberen Jun 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Please add your entries according to this format.

### Fixed

* Fixed not setting request body type correctly [#538].
* Fixed request headers not being redacted in case of failures [#545].
* Fixed wrongful processing of one shot and duplex requests [#544].
* Fixed writing to database on the main thread [#487].
Expand All @@ -25,6 +24,17 @@ Please add your entries according to this format.

* Updated OkHttp to 4.9.1

## Version 3.5.0 *(2021-06-29)*

### Added

* Android 12 support

### Fixed

* Fix crash on Android 12 due to missing immutability flags [#593]
* Fix not setting request body type correctly [#538].
vbuberen marked this conversation as resolved.
Show resolved Hide resolved

## Version 3.4.0 *(2020-11-05)*

### Added
Expand Down Expand Up @@ -488,3 +498,8 @@ Initial release.
[#465]: https://github.com/ChuckerTeam/chucker/issues/465
[#472]: https://github.com/ChuckerTeam/chucker/issues/472
[#480]: https://github.com/ChuckerTeam/chucker/issues/480
[#487]: https://github.com/ChuckerTeam/chucker/issues/487
[#538]: https://github.com/ChuckerTeam/chucker/issues/538
[#544]: https://github.com/ChuckerTeam/chucker/issues/544
[#545]: https://github.com/ChuckerTeam/chucker/issues/545
[#593]: https://github.com/ChuckerTeam/chucker/issues/593
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ Please note that you should add both the `library` and the the `library-no-op` v

```groovy
dependencies {
debugImplementation "com.github.chuckerteam.chucker:library:3.4.0"
releaseImplementation "com.github.chuckerteam.chucker:library-no-op:3.4.0"
debugImplementation "com.github.chuckerteam.chucker:library:3.5.0"
releaseImplementation "com.github.chuckerteam.chucker:library-no-op:3.5.0"
}
```

Expand Down Expand Up @@ -117,7 +117,7 @@ val chuckerInterceptor = ChuckerInterceptor.Builder(context)
// Use decoder when processing request and response bodies. When multiple decoders are installed they
// are applied in an order they were added.
.addBodyDecoder(decoder)
// Controls Android shortcut creation.
// Controls Android shortcut creation. Available in SNAPSHOTS versions only at the moment
.createShortcut(true)
.build()

Expand All @@ -142,6 +142,8 @@ interceptor.redactHeader("Auth-Token", "User-Session");

### Decode-Body 📖

**Warning** This feature is available in SNAPSHOT builds at the moment, not in 3.5.0

Chucker by default handles only plain text bodies. If you use a binary format like, for example, Protobuf or Thrift it won't be automatically handled by Chucker. You can, however, install a custom decoder that is capable to read data from different encodings.

```kotlin
Expand Down Expand Up @@ -177,8 +179,8 @@ repositories {
maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
}
dependencies {
debugImplementation "com.github.chuckerteam.chucker:library:3.4.1-SNAPSHOT"
releaseImplementation "com.github.chuckerteam.chucker:library-no-op:3.4.1-SNAPSHOT"
debugImplementation "com.github.chuckerteam.chucker:library:4.0.0-SNAPSHOT"
releaseImplementation "com.github.chuckerteam.chucker:library-no-op:4.0.0-SNAPSHOT"
}
```

Expand Down