eolivelli closed pull request #980: Release notes for 4.6.1 URL: https://github.com/apache/bookkeeper/pull/980
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/site/docs/4.6.1/api/ledger-api.md b/site/docs/4.6.1/api/ledger-api.md index 17a883568..c247bfb8f 100644 --- a/site/docs/4.6.1/api/ledger-api.md +++ b/site/docs/4.6.1/api/ledger-api.md @@ -30,6 +30,51 @@ If you're using [Maven](https://maven.apache.org/), add this to your [`pom.xml`] </dependency> ``` +BookKeeper uses google [protobuf](https://github.com/google/protobuf/tree/master/java) and [guava](https://github.com/google/guava) libraries +a lot. If your application might include different versions of protobuf or guava introduced by other dependencies, you can choose to use the +shaded library, which relocate classes of protobuf and guava into a different namespace to avoid conflicts. + +You can use the shaded artifact of `bookkeeper-server`. Please note that [maven-shade-plugin](https://maven.apache.org/plugins/maven-shade-plugin) doesn't generate +a dependency-reduced pom file for shaded artifact using [shadedArtifactAttached](https://maven.apache.org/plugins/maven-shade-plugin/examples/attached-artifact.html). You need to manually to exclude relocated packages when using the shaded artifact. Full example of how to use this is +showed as below. + +```xml +<!-- in your <properties> block --> +<bookkeeper.version>4.6.1</bookkeeper.version> + +<!-- in your <dependencies> block --> +<dependency> + <groupId>org.apache.bookkeeper</groupId> + <artifactId>bookkeeper-server</artifactId> + <version>${bookkeeper.version}</version> + <classifier>shaded</classifier> <!-- specify "shaded" classifier to use shaded artifact --> + <exclusions> + <exclusion> + <groupId>org.apache.bookkeeper</groupId> + <artifactId>bookkeeper-common</artifactId> + </exclusion> + <exclusion> + <groupId>org.apache.bookkeeper</groupId> + <artifactId>bookkeeper-proto</artifactId> + </exclusion> + </exclusions> +</dependency> +``` + +Or you can use a separate shaded artifact `bookkeeper-server-shaded`. + +```xml +<!-- in your <properties> block --> +<bookkeeper.version>4.6.1</bookkeeper.version> + +<!-- in your <dependencies> block --> +<dependency> + <groupId>org.apache.bookkeeper</groupId> + <artifactId>bookkeeper-server-shaded</artifactId> + <version>${bookkeeper.version}</version> +</dependency> +``` + ### Gradle If you're using [Gradle](https://gradle.org/), add this to your [`build.gradle`](https://spring.io/guides/gs/gradle/) build configuration file: @@ -45,6 +90,24 @@ dependencies { } ``` +Similarly as using maven, you can also configure to use the shaded jars. + +```groovy +// use the shaded artifact of `bookkeeper-server` jar +dependencies { + compile ('org.apache.bookkeeper:bookkeeper-server:{{ site.latest-version }}:shaded') { + exclude group: 'org.apache.bookkeeper', module: "bookkeeper-common' + exclude group: 'org.apache.bookkeeper', module: 'bookkeeper-proto' + } +} + + +// use the `bookkeeper-server-shaded` jar +dependencies { + compile 'org.apache.bookkeeper:bookkeeper-server-shaded:{{ site.latest-version }}' +} +``` + ## Connection string When interacting with BookKeeper using the Java client, you need to provide your client with a connection string, for which you have three options: diff --git a/site/docs/4.6.1/overview/releaseNotes.md b/site/docs/4.6.1/overview/releaseNotes.md index ac2c49847..7d7303606 100644 --- a/site/docs/4.6.1/overview/releaseNotes.md +++ b/site/docs/4.6.1/overview/releaseNotes.md @@ -2,18 +2,31 @@ title: Apache BookKeeper 4.6.1 Release Notes --- -This is the seventh release of BookKeeper as an Apache Top Level Project! +This is the eighth release of BookKeeper as an Apache Top Level Project! -The 4.6.1 release incorporates new fixes, improvements, and features since previous major release 4.5.0. +The 4.6.1 release is a bugfix release which fixes a bunch of issues reported from users of 4.6.0. Apache BookKeeper users are encouraged to upgrade to 4.6.1. The technical details of this release are summarized below. ## Highlights +- Fix critical bug on index persistence manager, see [https://github.com/apache/bookkeeper/pull/913](https://github.com/apache/bookkeeper/pull/913) + +- Fix critical bug to allow using versions of Netty newer than 4.1.2 on classpath, see [https://github.com/apache/bookkeeper/pull/996](https://github.com/apache/bookkeeper/pull/996) + +- Enhance Java 9 compatibility, see [https://github.com/apache/bookkeeper/issues/326](https://github.com/apache/bookkeeper/issues/326) + +- New option to track task execution time, see [https://github.com/apache/bookkeeper/issues/931](https://github.com/apache/bookkeeper/issues/931) + +- Distribute a version of BookKeeper which embeds and relocates Guava and Protobuf, see [https://github.com/apache/bookkeeper/issues/922](https://github.com/apache/bookkeeper/issues/922) + +- Add description for the new error code "Too many requests", see [https://github.com/apache/bookkeeper/pull/921](https://github.com/apache/bookkeeper/pull/921) ### Dependencies Upgrade +There is no dependency upgrade since 4.6.0, but now we distribute a 'shaded' version of main artifacts, see [Ledger API](../ledger-api) ## Full list of changes +- [https://github.com/apache/bookkeeper/issues?utf8=%E2%9C%93&q=label%3Arelease%2F4.6.1+is%3Aclosed](https://github.com/apache/bookkeeper/issues?utf8=%E2%9C%93&q=label%3Arelease%2F4.6.1+is%3Aclosed) ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
