From 24324ca6c61f64872376ed7f4ed22a3f1f0724f1 Mon Sep 17 00:00:00 2001 From: Sam Berlin Date: Fri, 5 May 2023 11:32:27 -0700 Subject: [PATCH] Prepare for the Guice 6.0 & 7.0 releases. This change does the following: * Bumps the snapshot version to 7.0.1-SNAPSHOT * Adds Guice 6 & Guice 7 release pages, with explanations of the jakarta transition & how Guice 6.0 & 7.0 should be used. They also include changelogs since 5.1.0. * Updates the top-level README to reference the 6.0 & 7.0 releases, as well as including "installation instructions" (which fixes #1698). * Updates the wiki to make sure it's meaningful for both javax & jakarta references, pointing to the correct ones where appropriate. PiperOrigin-RevId: 529770936 --- README.md | 44 +++++++++++++++++++++++++--- bom/pom.xml | 2 +- core/pom.xml | 2 +- extensions/assistedinject/pom.xml | 2 +- extensions/dagger-adapter/pom.xml | 2 +- extensions/grapher/pom.xml | 2 +- extensions/jmx/pom.xml | 2 +- extensions/jndi/pom.xml | 2 +- extensions/persist/pom.xml | 2 +- extensions/pom.xml | 2 +- extensions/servlet/pom.xml | 2 +- extensions/spring/pom.xml | 2 +- extensions/struts2/pom.xml | 2 +- extensions/testlib/pom.xml | 2 +- extensions/throwingproviders/pom.xml | 2 +- pom.xml | 2 +- 16 files changed, 55 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 15978c9db6..5e141ebc06 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,26 @@ Guice ==== - **Latest release: [5.1.0](https://github.com/google/guice/wiki/Guice510)** +- **Latest pre-releases:** + * **[6.0.0-rc2](https://github.com/google/guice/wiki/Guice600) (supports `jakarta.inject`, `jakarta.servlet`, and `jakarta.persistence`, [mostly supports](https://github.com/google/guice/wiki/Guice600#jee-jakarta-transition) `jakarta.inject`)** + * **[7.0.0-rc1](https://github.com/google/guice/wiki/Guice700) (supports `jakarta.inject`, `jakarta.servlet`, and `jakarta.persistence`)** - **Documentation:** - [User Guide](https://github.com/google/guice/wiki/Motivation), - [Latest javadocs](https://google.github.io/guice/api-docs/latest/javadoc/index.html) - [5.1.0 javadocs](https://google.github.io/guice/api-docs/5.1.0/javadoc/index.html) + * [User Guide](https://github.com/google/guice/wiki/Motivation), + * [5.1.0 javadocs](https://google.github.io/guice/api-docs/5.1.0/javadoc/index.html) + * [6.0.0 javadocs](https://google.github.io/guice/api-docs/6.0.0-rc2/javadoc/index.html) + * [7.0.0 javadocs](https://google.github.io/guice/api-docs/7.0.0-rc1/javadoc/index.html) + * [Latest Snapshot javadocs](https://google.github.io/guice/api-docs/latest/javadoc/index.html) - **Continuous Integration:** [![Build Status](https://github.com/google/guice/workflows/continuous-integration/badge.svg)](https://github.com/google/guice/actions) - **Mailing Lists:** [User Mailing List](http://groups.google.com/group/google-guice)
- **License:** [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0) +Overview +==== + Put simply, Guice alleviates the need for factories and the use of new in your Java code. Think of Guice's @Inject as the new new. You will still need to write factories in some cases, but your code will not depend directly on them. Your code will be easier to change, unit test and reuse in other contexts. -Guice embraces Java's type safe nature, especially when it comes to features introduced in Java 5 such as generics and annotations. You might think of Guice as filling in missing features for core Java. Ideally, the language itself would provide most of the same features, but until such a language comes along, we have Guice. +Guice embraces Java's type safe nature. You might think of Guice as filling in missing features for core Java. Ideally, the language itself would provide most of the same features, but until such a language comes along, we have Guice. Guice helps you design better APIs, and the Guice API itself sets a good example. Guice is not a kitchen sink. We justify each feature with at least three use cases. When in doubt, we leave it out. We build general functionality which enables you to extend Guice rather than adding every feature to the core framework. @@ -23,4 +31,32 @@ For an introduction to Guice and a comparison to new and the factory pattern, se We've been running Guice in mission critical applications since 2006, and now you can, too. We hope you enjoy it as much as we do. + +Installation Instructions +==== +Guice Core (Maven) +```xml + + com.google.inject + guice + + {version} + +``` + +Guice Extension (Maven) +```xml + + com.google.inject.extensions + + guice-{extension-name} + + {version} + +``` + +See [Maven Central](https://central.sonatype.com/artifact/com.google.inject/guice/) for more details, including snippets for other build systems such as Gradle, Ivy, sbt, and more. + +--- [![jolt award](https://user-images.githubusercontent.com/1885701/52603534-0d620380-2e1c-11e9-8cd5-95f0e141fcb0.png)](http://www.drdobbs.com/tools/winners-of-the-18th-jolt-product-excelle/207600666?pgno=6) diff --git a/bom/pom.xml b/bom/pom.xml index 5aa8788853..9d4707ec8b 100644 --- a/bom/pom.xml +++ b/bom/pom.xml @@ -6,7 +6,7 @@ com.google.inject guice-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT pom diff --git a/core/pom.xml b/core/pom.xml index d60694769f..2b295101be 100644 --- a/core/pom.xml +++ b/core/pom.xml @@ -6,7 +6,7 @@ com.google.inject guice-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT guice diff --git a/extensions/assistedinject/pom.xml b/extensions/assistedinject/pom.xml index 0de658f570..e8ea03f55a 100644 --- a/extensions/assistedinject/pom.xml +++ b/extensions/assistedinject/pom.xml @@ -6,7 +6,7 @@ com.google.inject.extensions extensions-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT guice-assistedinject diff --git a/extensions/dagger-adapter/pom.xml b/extensions/dagger-adapter/pom.xml index 256bd5adfe..4b4eb5a325 100644 --- a/extensions/dagger-adapter/pom.xml +++ b/extensions/dagger-adapter/pom.xml @@ -5,7 +5,7 @@ com.google.inject.extensions extensions-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT guice-dagger-adapter Google Guice - Extensions - Dagger Adapter diff --git a/extensions/grapher/pom.xml b/extensions/grapher/pom.xml index 00547ec5cc..1c8a3c82be 100644 --- a/extensions/grapher/pom.xml +++ b/extensions/grapher/pom.xml @@ -6,7 +6,7 @@ com.google.inject.extensions extensions-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT guice-grapher diff --git a/extensions/jmx/pom.xml b/extensions/jmx/pom.xml index fd8feaaa62..a6ded8a4a6 100644 --- a/extensions/jmx/pom.xml +++ b/extensions/jmx/pom.xml @@ -6,7 +6,7 @@ com.google.inject.extensions extensions-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT guice-jmx diff --git a/extensions/jndi/pom.xml b/extensions/jndi/pom.xml index de99f44e1e..efd3f2f730 100644 --- a/extensions/jndi/pom.xml +++ b/extensions/jndi/pom.xml @@ -6,7 +6,7 @@ com.google.inject.extensions extensions-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT guice-jndi diff --git a/extensions/persist/pom.xml b/extensions/persist/pom.xml index 3b53fbcfa1..7d57fbe57f 100644 --- a/extensions/persist/pom.xml +++ b/extensions/persist/pom.xml @@ -6,7 +6,7 @@ com.google.inject.extensions extensions-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT guice-persist diff --git a/extensions/pom.xml b/extensions/pom.xml index e5f641af98..8779338eb2 100644 --- a/extensions/pom.xml +++ b/extensions/pom.xml @@ -6,7 +6,7 @@ com.google.inject guice-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT pom diff --git a/extensions/servlet/pom.xml b/extensions/servlet/pom.xml index dc301fd21a..17b6d3a9b6 100644 --- a/extensions/servlet/pom.xml +++ b/extensions/servlet/pom.xml @@ -6,7 +6,7 @@ com.google.inject.extensions extensions-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT guice-servlet diff --git a/extensions/spring/pom.xml b/extensions/spring/pom.xml index 36ca171583..7430e1a04f 100644 --- a/extensions/spring/pom.xml +++ b/extensions/spring/pom.xml @@ -6,7 +6,7 @@ com.google.inject.extensions extensions-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT guice-spring diff --git a/extensions/struts2/pom.xml b/extensions/struts2/pom.xml index 6cb1511931..9b17770ec4 100644 --- a/extensions/struts2/pom.xml +++ b/extensions/struts2/pom.xml @@ -6,7 +6,7 @@ com.google.inject.extensions extensions-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT guice-struts2 diff --git a/extensions/testlib/pom.xml b/extensions/testlib/pom.xml index ff53e1488a..9dc0ab1364 100644 --- a/extensions/testlib/pom.xml +++ b/extensions/testlib/pom.xml @@ -6,7 +6,7 @@ com.google.inject.extensions extensions-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT guice-testlib diff --git a/extensions/throwingproviders/pom.xml b/extensions/throwingproviders/pom.xml index 3ab184a517..f02274a07f 100644 --- a/extensions/throwingproviders/pom.xml +++ b/extensions/throwingproviders/pom.xml @@ -6,7 +6,7 @@ com.google.inject.extensions extensions-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT guice-throwingproviders diff --git a/pom.xml b/pom.xml index 95fb7d2950..9a18269586 100644 --- a/pom.xml +++ b/pom.xml @@ -27,7 +27,7 @@ See the Apache License Version 2.0 for the specific language governing permissio com.google.inject guice-parent - 5.1.1-SNAPSHOT + 7.0.1-SNAPSHOT Google Guice