This is an automated email from the ASF dual-hosted git repository. benweidig pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/tapestry-5-site.git
commit 2e75eafc5b341a03a7188cfd3d89c4a336b90446 Author: Ben Weidig <[email protected]> AuthorDate: Sat Aug 29 11:18:58 2026 +0200 Reflect the 5.9 release on the main site - antora.yml: tapestry-version 5.8.7 -> 5.9.1 - download: explain the Jakarta and javax flavours and their artifact ids - getting-started: bump versions to 5.9.1, warn that the 5.9.1 archetype mixes jakarta.servlet-api with the unsuffixed Tapestry artifacts - supported-environments-and-versions: add 5.9 columns to the Java/Servlet, app server and library tables - documentation: fill in the empty Release Notes, Javadoc and FAQ sections - nav: lift the Documentation entries to level one in the sidebar --- antora.yml | 2 +- modules/ROOT/nav.adoc | 23 ++++++++------- modules/ROOT/pages/documentation.adoc | 33 ++++++++++++++++++++-- modules/ROOT/pages/download.adoc | 30 ++++++++++++++++++-- modules/ROOT/pages/getting-started.adoc | 28 ++++++++++++++---- .../pages/supported-environments-and-versions.adoc | 27 +++++++++++++++--- 6 files changed, 115 insertions(+), 28 deletions(-) diff --git a/antora.yml b/antora.yml index 250aa7f..9116450 100644 --- a/antora.yml +++ b/antora.yml @@ -7,4 +7,4 @@ nav: asciidoc: attributes: experimental: true # must be true to support User Interface Macros - tapestry-version: 5.8.7 + tapestry-version: 5.9.1 diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 9e44d18..023cfc9 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -1,14 +1,13 @@ * xref:about.adoc[] * xref:principles.adoc[] -* Documentation -** xref:getting-started.adoc[] -** Tutorial -*** xref:tutorial:index.adoc[] -*** xref:tutorial:dependencies-tools-and-plugins.adoc[] -*** xref:tutorial:creating-the-skeleton-application.adoc[] -*** xref:tutorial:exploring-the-project.adoc[] -*** xref:tutorial:implementing-the-hi-lo-guessing-game.adoc[] -*** xref:tutorial:using-beaneditform-to-create-user-forms.adoc[] -*** xref:tutorial:using-tapestry-with-hibernate.adoc[] -** xref:userguide.adoc[] - +* xref:getting-started.adoc[] +* Tutorial +** xref:tutorial:index.adoc[] +** xref:tutorial:dependencies-tools-and-plugins.adoc[] +** xref:tutorial:creating-the-skeleton-application.adoc[] +** xref:tutorial:exploring-the-project.adoc[] +** xref:tutorial:implementing-the-hi-lo-guessing-game.adoc[] +** xref:tutorial:using-beaneditform-to-create-user-forms.adoc[] +** xref:tutorial:using-tapestry-with-hibernate.adoc[] +* xref:userguide.adoc[] +* xref:documentation.adoc[] diff --git a/modules/ROOT/pages/documentation.adoc b/modules/ROOT/pages/documentation.adoc index 8a845ee..48df66e 100644 --- a/modules/ROOT/pages/documentation.adoc +++ b/modules/ROOT/pages/documentation.adoc @@ -2,16 +2,43 @@ :navtitle: Documentation == User Guide -xref:userguide::index.adoc[] +The xref:userguide::index.adoc[User Guide] is the reference documentation for Tapestry, versioned alongside the framework. +Use the version selector to switch between releases. + +Two companion sections sit next to it in the same navigation: a *Cookbook* of worked recipes (including the xref:userguide:cookbook:ioc-cookbook.adoc[IoC Cookbook]) and the *FAQ*. + +== Getting Started +* xref:getting-started.adoc[] – create and run your first application. +* xref:tutorial:index.adoc[Tutorial] – a step-by-step walkthrough building a small application. == Release Notes +* xref:userguide::release-notes-5.9.adoc[Tapestry 5.9] – the current release, built on Jakarta EE 9. +* xref:userguide::release-notes-5.8.adoc[Tapestry 5.8] +* xref:userguide::release-notes-5.7.adoc[Tapestry 5.7] +* xref:userguide::release-notes-5.6.adoc[Tapestry 5.6] +* xref:userguide::release-notes-5.5.adoc[Tapestry 5.5] +* xref:userguide::release-notes-5.4.adoc[Tapestry 5.4] + +Older release notes are available from the Release Notes section of the User Guide navigation. + +Upgrading to 5.9 from an earlier release? +Start with the xref:userguide::jakarta-ee-migration.adoc[Jakarta EE migration guide]. == Javadoc +* https://tapestry.apache.org/current/apidocs/[Current release] +* https://tapestry.apache.org/5.9.0/apidocs/[5.9.0] +* https://tapestry.apache.org/5.8.7/apidocs/[5.8.7] +* https://tapestry.apache.org/5.7.3/apidocs/[5.7.3] + +Javadoc for every release is also available as a zip from the xref:download.adoc[download page]. == FAQ +* xref:userguide:faq:general.adoc[General] +* xref:userguide:faq:ajax.adoc[Ajax] +* xref:userguide:faq:templating-and-markup.adoc[Templating and Markup] -== Tutorials +== Compatibility +xref:supported-environments-and-versions.adoc[] lists the Java, Servlet API, app server and library versions each Tapestry release is known to work with. == Learning Resources from the Community https://tapestry-jumpstart.org/[Tapestry Jumpstart] by Geoff Callender - diff --git a/modules/ROOT/pages/download.adoc b/modules/ROOT/pages/download.adoc index 058943e..bbb4b43 100644 --- a/modules/ROOT/pages/download.adoc +++ b/modules/ROOT/pages/download.adoc @@ -4,22 +4,46 @@ Tapestry can be downloaded from various places, described below, in either binar == Using a Build Tool The easiest way is to download Tapestry and its dependencies from the https://repo1.maven.org/maven2/[Maven Central Repository], leveraging a build tool such as https://maven.apache.org/[Apache Maven], https://www.gradle.org/[Gradle] etc. -Just declare a dependency on Tapestry (see below for sample dependency declararions) and let the build tool take care of downloading the necessary files to your local machine. +Just declare a dependency on Tapestry (see below for sample dependency declararions) and let the build tool take care of downloading the necessary files to your local machine. + +=== Jakarta EE or javax? + +Since 5.9, Tapestry is published in two flavours from the same source, at the same version number: + +[%autowidth] +|=== +|Flavour |Servlet API |Artifact ids |Containers + +|*Jakarta* (recommended for new projects) +|`jakarta.servlet` 5.0 +|suffixed with `-jakarta` +|Tomcat 10+, Jetty 11+ + +|*javax* (for existing applications) +|`javax.servlet` 3.0+ +|unchanged +|Tomcat 9, Jetty 9-10 +|=== + +Both contain the same features and fixes. +Pick the one that matches your servlet container, and don't mix the two. +See the xref:userguide::jakarta-ee-migration.adoc[Jakarta EE migration guide] for the full list of affected artifacts and what to change in your code. .Maven: Dependency on Tapestry to be added to your `pom.xml` [source,xml,subs="+attributes"] ---- <dependency> <groupId>org.apache.tapestry</groupId> - <artifactId>tapestry-core</artifactId> + <artifactId>tapestry-core-jakarta</artifactId> <!--1--> <version>{tapestry-version}</version> </dependency> ---- +<1> Use `tapestry-core` instead for the javax flavour. .Gradle: Dependency on Tapestry to be added to your `build.gradle` [source,gradle,subs="+attributes"] ---- -implementation 'org.apache.tapestry:tapestry-core:{tapestry-version}' +implementation 'org.apache.tapestry:tapestry-core-jakarta:{tapestry-version}' ---- diff --git a/modules/ROOT/pages/getting-started.adoc b/modules/ROOT/pages/getting-started.adoc index 80faf46..9f01391 100644 --- a/modules/ROOT/pages/getting-started.adoc +++ b/modules/ROOT/pages/getting-started.adoc @@ -24,9 +24,26 @@ mvn archetype:generate -Dfilter=org.apache.tapestry:quickstart ---- (Alternatively, if you want to get an archetype for a not-yet-released version of Tapestry – most users don't – you can use the staging URI, https://repository.apache.org/content/repositories/staging ). -// TODO explain how to use the stagingn URI +// TODO explain how to use the stagingn URI -Maven will prompt you for the archetype to create ("Tapestry 5 Quickstart Project") and the exact version number (e.g., "5.8.7"). +[IMPORTANT] +==== +*Check the generated `pom.xml` when using the 5.9.1 archetype.* + +Tapestry 5.9 ships in a Jakarta EE flavour (artifacts suffixed with `-jakarta`) and a javax flavour (unsuffixed artifacts), as explained on the xref:download.adoc[] page. +The generated project declares `jakarta.servlet-api` and the Jetty 11 plugin, which need the Jakarta flavour, but still names the unsuffixed Tapestry artifacts. +Before running the project, change the Tapestry dependencies to their `-jakarta` names: + +[source,xml] +---- +<artifactId>tapestry-core-jakarta</artifactId> +<artifactId>tapestry-webresources-jakarta</artifactId> +---- + +Alternatively, keep the unsuffixed artifacts and replace `jakarta.servlet:jakarta.servlet-api` with `javax.servlet:javax.servlet-api` and the Jetty 11 plugin with Jetty 10, to build a javax project instead. +==== + +Maven will prompt you for the archetype to create ("Tapestry 5 Quickstart Project") and the exact version number (e.g., "5.9.1"). It also asks you for a group id, an artifact id, and a version number. You can see this in the following transcript: ---- @@ -58,7 +75,8 @@ Choose org.apache.tapestry:quickstart version: 7: 5.6.4 8: 5.7.3 9: 5.8.7 -Choose a number: 9: 9 +10: 5.9.1 +Choose a number: 10: 10 Define value for property 'groupId': : com.example Define value for property 'artifactId': : newapp Define value for property 'version': 1.0-SNAPSHOT: : @@ -70,7 +88,7 @@ version: 1.0-SNAPSHOT package: com.example.newapp Y: : Y [INFO] ---------------------------------------------------------------------------- -[INFO] Using following parameters for creating project from Archetype: quickstart:5.8.6 +[INFO] Using following parameters for creating project from Archetype: quickstart:5.9.1 [INFO] ---------------------------------------------------------------------------- [INFO] Parameter: groupId, Value: com.example [INFO] Parameter: artifactId, Value: newapp @@ -114,7 +132,7 @@ Application 'app' (version 1.0-SNAPSHOT-DEV) startup time: 329 ms to build IoC R /_ __/__ ____ ___ ___ / /_______ __ / __/ / / / _ `/ _ \/ -_|_-</ __/ __/ // / /__ \ /_/ \_,_/ .__/\__/___/\__/_/ \_, / /____/ - /_/ /___/ 5.8.7 (development mode) + /_/ /___/ 5.9.1 (development mode) [INFO] Started [email protected]:8080 [INFO] Started Jetty Server diff --git a/modules/ROOT/pages/supported-environments-and-versions.adoc b/modules/ROOT/pages/supported-environments-and-versions.adoc index b34b6f4..406a468 100644 --- a/modules/ROOT/pages/supported-environments-and-versions.adoc +++ b/modules/ROOT/pages/supported-environments-and-versions.adoc @@ -10,9 +10,10 @@ If you know of any other known compatibilities or incompatibilities, please add [%autowidth] |=== -|Tapestry | 5.8.4+ | 5.8.1 - 5.8-3 |5.7 |5.6 |5.5 |5.4 |5.3.8 |5.3.0 - 5.3.7 |5.0 - 5.2 +|Tapestry |5.9 | 5.8.4+ | 5.8.1 - 5.8-3 |5.7 |5.6 |5.5 |5.4 |5.3.8 |5.3.0 - 5.3.7 |5.0 - 5.2 |Java JRE +|11-21 footnote:java59[Tapestry 5.9 is still compiled to Java 8 bytecode, but Java 11 is the practical minimum because of the Jakarta EE 9 stack it depends on. The project's CI matrix covers Java 11 and 17. `tapestry-spring` depends on Spring 6 and therefore requires Java 17.] |8-21 |8-17 |8-14 @@ -24,7 +25,8 @@ If you know of any other known compatibilities or incompatibilities, please add |5,6 |Servlet API -|3.0+ +|Jakarta Servlet 5.0 footnote:jakarta59[Tapestry 5.9 ships in two flavours: the Jakarta one (artifacts suffixed with `-jakarta`) targets Jakarta Servlet 5.0, and the javax one (unsuffixed artifacts) keeps targeting `javax.servlet` 3.0+. See the xref:userguide::jakarta-ee-migration.adoc[Jakarta EE migration guide].] +|3.0+ |3.0+ |3.0+ |3.0+ @@ -38,9 +40,11 @@ If you know of any other known compatibilities or incompatibilities, please add == App Servers [%autowidth] |=== -|Tapestry |5.5+ |5.4 |5.3.8 |5.3.0 - 5.3.7 |5.2 |5.1 | 5.0.10 |5.0.8|5.0 +|Tapestry |5.9 (Jakarta) |5.9 (javax) |5.5+ |5.4 |5.3.8 |5.3.0 - 5.3.7 |5.2 |5.1 | 5.0.10 |5.0.8|5.0 |Apache Tomcat +|10+ +|9 |6+ | | @@ -52,6 +56,8 @@ If you know of any other known compatibilities or incompatibilities, please add | |Jetty +|11+ +|9-10 |9 |7-9 |6-9 @@ -68,6 +74,8 @@ If you know of any other known compatibilities or incompatibilities, please add | | | +| +| |2.1 | | @@ -75,6 +83,8 @@ If you know of any other known compatibilities or incompatibilities, please add |JBoss EAP | +| +| |4.2.3 | | @@ -91,10 +101,11 @@ These are the library versions known to work (and, in some cases, bundled with T [%autowidth] |=== -|Tapestry |5.7.3+ |5.5+ |5.4.1 |5.4 |5.3.8 |5.3.7 | 5.3.3-5.3.6 |5.3.2|5.3 - 5.3.1 |5.2.1 - 5.2.0 |5.1 |5.0.16 |5.0.10 |5.0.8 |5.0 +|Tapestry |5.9 |5.7.3+ |5.5+ |5.4.1 |5.4 |5.3.8 |5.3.7 | 5.3.3-5.3.6 |5.3.2|5.3 - 5.3.1 |5.2.1 - 5.2.0 |5.1 |5.0.16 |5.0.10 |5.0.8 |5.0 |Hibernate |5.4.32.Final +|5.4.32.Final |5.1.0.Final | |? - 4.3.6 @@ -111,6 +122,7 @@ These are the library versions known to work (and, in some cases, bundled with T | |Spring +|6.0.11 | | | @@ -130,6 +142,7 @@ These are the library versions known to work (and, in some cases, bundled with T |jQuery.js | | +| |1.12.1 | | @@ -148,6 +161,7 @@ These are the library versions known to work (and, in some cases, bundled with T | | | +| |1.7.1 | |1.7 @@ -166,6 +180,7 @@ These are the library versions known to work (and, in some cases, bundled with T | | | +| |1.9 |1.9 |1.9 @@ -180,6 +195,7 @@ These are the library versions known to work (and, in some cases, bundled with T |Bootstrap CSS | +| |4.3.1, 3.3.6 |3.3.6 |3.0.2 @@ -198,6 +214,7 @@ These are the library versions known to work (and, in some cases, bundled with T |Moment.js | | +| |2.12.0 | | @@ -216,6 +233,7 @@ These are the library versions known to work (and, in some cases, bundled with T | | | +| |1.2.1 - 1.9 | | @@ -236,6 +254,7 @@ These are the library versions known to work (and, in some cases, bundled with T | | | +| |1.3.3 |1.1.7 |1.1.7
