Prepare for the Guice 6.0 & 7.0 releases. This change does the follow…

…ing: * 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
google · May 5, 2023 · 24324ca · 24324ca
1 parent 49b1a33
commit 24324ca
Show file tree

Hide file tree

Showing 16 changed files with 55 additions and 19 deletions.
diff --git 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) <br/>
 -   **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
+<dependency>
+  <groupId>com.google.inject</groupId>
+  <artifactId>guice</artifactId>
+  <!-- {version} can be 5.1.0, 6.0.0-rc2, 7.0.0-rc1, etc. -->
+  <version>{version}</version>
+</dependency>
+```
+
+Guice Extension (Maven)
+```xml
+<dependency>
+  <groupId>com.google.inject.extensions</groupId>
+  <!-- {extension-name} can be one of: assistedinject, dagger-adapter,
+       grapher, jmx, jndi, persist, spring, testlib or throwingproviders -->
+  <artifactId>guice-{extension-name}</artifactId>
+  <!-- {version} must match the guice core version. -->
+  <version>{version}</version>
+</dependency>
+```
+
+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
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.google.inject</groupId>
     <artifactId>guice-parent</artifactId>
-    <version>5.1.1-SNAPSHOT</version>
+    <version>7.0.1-SNAPSHOT</version>
   </parent>
 
   <packaging>pom</packaging>

diff --git a/core/pom.xml b/core/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.google.inject</groupId>
     <artifactId>guice-parent</artifactId>
-    <version>5.1.1-SNAPSHOT</version>
+    <version>7.0.1-SNAPSHOT</version>
   </parent>
 
   <artifactId>guice</artifactId>

diff --git a/extensions/assistedinject/pom.xml b/extensions/assistedinject/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.google.inject.extensions</groupId>
     <artifactId>extensions-parent</artifactId>
-    <version>5.1.1-SNAPSHOT</version>
+    <version>7.0.1-SNAPSHOT</version>
   </parent>
 
   <artifactId>guice-assistedinject</artifactId>

diff --git a/extensions/dagger-adapter/pom.xml b/extensions/dagger-adapter/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>com.google.inject.extensions</groupId>
     <artifactId>extensions-parent</artifactId>
-    <version>5.1.1-SNAPSHOT</version>
+    <version>7.0.1-SNAPSHOT</version>
   </parent>
   <artifactId>guice-dagger-adapter</artifactId>
   <name>Google Guice - Extensions - Dagger Adapter</name>

diff --git a/extensions/grapher/pom.xml b/extensions/grapher/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.google.inject.extensions</groupId>
     <artifactId>extensions-parent</artifactId>
-    <version>5.1.1-SNAPSHOT</version>
+    <version>7.0.1-SNAPSHOT</version>
   </parent>
 
   <artifactId>guice-grapher</artifactId>

diff --git a/extensions/jmx/pom.xml b/extensions/jmx/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.google.inject.extensions</groupId>
     <artifactId>extensions-parent</artifactId>
-    <version>5.1.1-SNAPSHOT</version>
+    <version>7.0.1-SNAPSHOT</version>
   </parent>
 
   <artifactId>guice-jmx</artifactId>

diff --git a/extensions/jndi/pom.xml b/extensions/jndi/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.google.inject.extensions</groupId>
     <artifactId>extensions-parent</artifactId>
-    <version>5.1.1-SNAPSHOT</version>
+    <version>7.0.1-SNAPSHOT</version>
   </parent>
 
   <artifactId>guice-jndi</artifactId>

diff --git a/extensions/persist/pom.xml b/extensions/persist/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.google.inject.extensions</groupId>
     <artifactId>extensions-parent</artifactId>
-    <version>5.1.1-SNAPSHOT</version>
+    <version>7.0.1-SNAPSHOT</version>
   </parent>
 
   <artifactId>guice-persist</artifactId>

diff --git a/extensions/pom.xml b/extensions/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.google.inject</groupId>
     <artifactId>guice-parent</artifactId>
-    <version>5.1.1-SNAPSHOT</version>
+    <version>7.0.1-SNAPSHOT</version>
   </parent>
 
   <packaging>pom</packaging>

diff --git a/extensions/servlet/pom.xml b/extensions/servlet/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.google.inject.extensions</groupId>
     <artifactId>extensions-parent</artifactId>
-    <version>5.1.1-SNAPSHOT</version>
+    <version>7.0.1-SNAPSHOT</version>
   </parent>
 
   <artifactId>guice-servlet</artifactId>

diff --git a/extensions/spring/pom.xml b/extensions/spring/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.google.inject.extensions</groupId>
     <artifactId>extensions-parent</artifactId>
-    <version>5.1.1-SNAPSHOT</version>
+    <version>7.0.1-SNAPSHOT</version>
   </parent>
 
   <artifactId>guice-spring</artifactId>

diff --git a/extensions/struts2/pom.xml b/extensions/struts2/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.google.inject.extensions</groupId>
     <artifactId>extensions-parent</artifactId>
-    <version>5.1.1-SNAPSHOT</version>
+    <version>7.0.1-SNAPSHOT</version>
   </parent>
 
   <artifactId>guice-struts2</artifactId>

diff --git a/extensions/testlib/pom.xml b/extensions/testlib/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.google.inject.extensions</groupId>
     <artifactId>extensions-parent</artifactId>
-    <version>5.1.1-SNAPSHOT</version>
+    <version>7.0.1-SNAPSHOT</version>
   </parent>
 
   <artifactId>guice-testlib</artifactId>

diff --git a/extensions/throwingproviders/pom.xml b/extensions/throwingproviders/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>com.google.inject.extensions</groupId>
     <artifactId>extensions-parent</artifactId>
-    <version>5.1.1-SNAPSHOT</version>
+    <version>7.0.1-SNAPSHOT</version>
   </parent>
 
   <artifactId>guice-throwingproviders</artifactId>

diff --git a/pom.xml b/pom.xml
@@ -27,7 +27,7 @@ See the Apache License Version 2.0 for the specific language governing permissio
 
   <groupId>com.google.inject</groupId>
   <artifactId>guice-parent</artifactId>
-  <version>5.1.1-SNAPSHOT</version>
+  <version>7.0.1-SNAPSHOT</version>
 
   <name>Google Guice</name>