You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2021/07/20 08:15:48 UTC
[isis] branch master updated: ISIS-2808: updating docs and mignotes
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/master by this push:
new 0c7c539 ISIS-2808: updating docs and mignotes
0c7c539 is described below
commit 0c7c53934b65ddf63ea9e47842a9cc3d487e68d2
Author: Andi Huber <ah...@apache.org>
AuthorDate: Tue Jul 20 10:15:35 2021 +0200
ISIS-2808: updating docs and mignotes
---
.../comguide/modules/ROOT/pages/cutting-a-release.adoc | 2 +-
.../modules/ROOT/pages/building-apache-isis.adoc | 10 ++++------
.../modules/ROOT/pages/2021/2.0.0-M6/mignotes.adoc | 10 ++++++++++
mavendeps/adoc/modules/mavendeps/pages/about.adoc | 17 +++++++----------
starters/adoc/modules/starters/pages/helloworld.adoc | 2 +-
starters/adoc/modules/starters/pages/simpleapp.adoc | 2 +-
6 files changed, 24 insertions(+), 19 deletions(-)
diff --git a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
index fb33d6e..de0d9d1 100644
--- a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
+++ b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc
@@ -254,7 +254,7 @@ mvn install -o -DskipTests -Dreleased
====
The `released` system property is set to only sanity check the modules actually to be released (ignores the incubator modules).
-Partly that's because there's no need to check the incubator modules, it's also because the incubator modules require Java 11 (Java 8 is used for everything else)
+Partly that's because there's no need to check the incubator modules, it's also because the incubator modules might require new than Java 11 (Java 11 is used for everything else)
====
* next we also update the starters (as used by applications built using the framework):
diff --git a/antora/components/conguide/modules/ROOT/pages/building-apache-isis.adoc b/antora/components/conguide/modules/ROOT/pages/building-apache-isis.adoc
index 5c6cab3..a1fec6f 100644
--- a/antora/components/conguide/modules/ROOT/pages/building-apache-isis.adoc
+++ b/antora/components/conguide/modules/ROOT/pages/building-apache-isis.adoc
@@ -130,22 +130,20 @@ For further reading, see:
== Installing Java
-Apache Isis v2 is compatible with Java 8 and above, and releases are xref:comguide:ROOT:cutting-a-release.adoc[cut] using Java 8, leveraging the link:http://maven.apache.org/plugins/maven-toolchains-plugin/[Maven toolchains plugin]).
+Apache Isis v2 is compatible with Java 11 and above, and releases are xref:comguide:ROOT:cutting-a-release.adoc[cut] using Java 11, leveraging the link:http://maven.apache.org/plugins/maven-toolchains-plugin/[Maven toolchains plugin]).
-Some of the tooling used to generate documentation uses Java 11.
-
-Therefore install either/both of Java 8 JDK and Java 11 JDK.
+Therefore install Java 11 JDK or newer.
Note that the JRE is _not_ sufficient.
[TIP]
====
-If you intend to contribute back patches to Apache Isis, note that while you can develop using Java 11 or above within your IDE, be sure not to use any APIs more recent than Java 8.
+If you intend to contribute back patches to Apache Isis, note that while you can develop using Java 11 or above within your IDE, be sure not to use any APIs more recent than Java 11.
====
=== Configure Maven toolchains plugin
If you are a committer that will be performing releases of Apache Isis, then you _must_ configure the
-link:http://maven.apache.org/plugins/maven-toolchains-plugin/[toolchains] plugin so that releases can be built using Java 8.
+link:http://maven.apache.org/plugins/maven-toolchains-plugin/[toolchains] plugin so that releases can be built using Java 11.
This is done by placing the `toolchains.xml` file in `~/.m2` directory.
Use the following file as a template, adjusting paths for your platform:
diff --git a/antora/components/relnotes/modules/ROOT/pages/2021/2.0.0-M6/mignotes.adoc b/antora/components/relnotes/modules/ROOT/pages/2021/2.0.0-M6/mignotes.adoc
index e99b2d7..4e66b5c 100644
--- a/antora/components/relnotes/modules/ROOT/pages/2021/2.0.0-M6/mignotes.adoc
+++ b/antora/components/relnotes/modules/ROOT/pages/2021/2.0.0-M6/mignotes.adoc
@@ -6,6 +6,16 @@
(This page will be added to as development progresses).
+== Java Source Compliance Level
+
+The minimum required JVM version was updated from Java 8 to Java 11.
+
+A number of packages related to JavaEE were removed from the JRE, but these packages are used by the framework, specifically
+
+* JAX-WS packages (`javax.jws`, `javax.jws.soap`, `javax.xml.soap`, and `javax.xml.ws.*`)
+* JAXB packages (`javax.xml.bind.*`)
+
+
== Changes to the Programming Model
=== Removed (Programming Model)
diff --git a/mavendeps/adoc/modules/mavendeps/pages/about.adoc b/mavendeps/adoc/modules/mavendeps/pages/about.adoc
index c8339bf..c56155c 100644
--- a/mavendeps/adoc/modules/mavendeps/pages/about.adoc
+++ b/mavendeps/adoc/modules/mavendeps/pages/about.adoc
@@ -218,19 +218,14 @@ xref:testing:fixtures:about.adoc[Fixture Scripts]
== jdk11
-While Apache Isis v2 will run happily on Java 8, it is of course also possible to it on later versions.
+While Apache Isis v2 will run happily on Java 11, it is of course also possible to run it on later versions.
-However, between Java 8 and Java 11 a number of packages related to JavaEE were removed from the JRE, but these packages are used by the framework, specifically
+Hsitorically, between Java 8 and Java 11 a number of packages related to JavaEE were removed from the JRE, but these packages are used by the framework, specifically
* JAX-WS packages (`javax.jws`, `javax.jws.soap`, `javax.xml.soap`, and `javax.xml.ws.*`)
* JAXB packages (`javax.xml.bind.*`)
-So, if you _do_ want to run your Apache Isis application on Java 11 or later, then these dependencies need to be added in.
-
-
-All you need to do is include this dependency in the webapp module:
-
-To use, add the following :
+These dependencies are added in automatically. For reference, these dependencies are bundled with:
[source,xml]
.pom.xml
@@ -244,8 +239,10 @@ To use, add the following :
</dependencies>
----
-If you are running on JDK11, then this will activate a profile to bring in the missing packages.
-Otherwise it will be ignored.
+[NOTE]
+====
+TODO v2 - once JDK 17 is released, we might consider upgrading this module to provide any dependencies that are in JDK 11 but not in JDK 17 (if any), and with that rename this module to _jdk17_.
+====
For more on this topic, see:
diff --git a/starters/adoc/modules/starters/pages/helloworld.adoc b/starters/adoc/modules/starters/pages/helloworld.adoc
index b32462d..321fcb2 100644
--- a/starters/adoc/modules/starters/pages/helloworld.adoc
+++ b/starters/adoc/modules/starters/pages/helloworld.adoc
@@ -26,7 +26,7 @@ Apache Isis is a Java based framework, so in terms of prerequisites, you'll need
* Java 11 JDK (or later)
+
-Apache Isis itself is compatible with Java 8, but the helloworld app itself is configured for Java 11.
+Apache Isis itself is compatible with Java 11, and the helloworld app itself is configured for Java 11.
* link:http://maven.apache.org[Apache Maven] 3.5+
diff --git a/starters/adoc/modules/starters/pages/simpleapp.adoc b/starters/adoc/modules/starters/pages/simpleapp.adoc
index 597abfc..38a9d9c 100644
--- a/starters/adoc/modules/starters/pages/simpleapp.adoc
+++ b/starters/adoc/modules/starters/pages/simpleapp.adoc
@@ -33,7 +33,7 @@ Apache Isis is a Java based framework, so in terms of prerequisites, you'll need
* Java 11 JDK (or later)
+
-Apache Isis itself is compatible with Java 8, but the simpleapp itself is configured for Java 11.
+Apache Isis itself is compatible with Java 11, and the simpleapp itself is configured for Java 11.
* link:http://maven.apache.org[Apache Maven] 3.5+