This is an automated email from the ASF dual-hosted git repository. danhaywood pushed a commit to branch 3.0.0 in repository https://gitbox.apache.org/repos/asf/causeway.git
commit 8e35ab8e867fef35c3625bac71a3dddbfacba3bf Author: danhaywood <[email protected]> AuthorDate: Mon Mar 25 22:28:27 2024 +0000 CAUSEWAY-3666 : updates relnotes for v2 and v3 --- .../modules/ROOT/pages/cutting-a-release.adoc | 2 +- .../ROOT/pages/post-release-successful.adoc | 2 +- .../conguide/modules/documentation/nav.adoc | 2 +- .../documentation/pages/asciidoc-syntax.adoc | 14 +- .../pages/building-docs-and-website.adoc | 8 +- .../docs/modules/referenceapp/pages/about.adoc | 2 +- .../modules/applib-svc/partials/_metadata-api.adoc | 2 +- .../modules/ROOT/pages/2020/2.0.0-M3/relnotes.adoc | 2 +- .../modules/ROOT/pages/2020/2.0.0-M4/relnotes.adoc | 2 +- .../ROOT/pages/2023/2.0.0-RC3/mignotes.adoc | 9 +- .../modules/ROOT/pages/2024/2.0.0/mignotes.adoc | 5 +- .../modules/ROOT/pages/2024/2.0.0/relnotes.adoc | 13 +- .../modules/ROOT/pages/2024/3.0.0/mignotes.adoc | 35 ++++ .../modules/ROOT/pages/2024/3.0.0/relnotes.adoc | 32 ++++ .../relnotes/modules/ROOT/pages/about.adoc | 30 ++-- .../ROOT/partials/2024/2.0.0/_relnotes.adoc | 186 +++++++++++++++++++++ .../userguide/modules/ROOT/pages/overview.adoc | 2 +- .../userguide/modules/ROOT/pages/value-types.adoc | 2 +- core/adoc/modules/ROOT/pages/about.adoc | 2 +- .../vw/sse/adoc/modules/sse/pages/about.adoc | 2 +- .../cli/adoc/modules/tooling-cli/pages/about.adoc | 2 +- .../adoc/modules/asciidoc/pages/about.adoc | 2 +- .../adoc/modules/asciidoc/partials/module-nav.adoc | 2 +- 23 files changed, 306 insertions(+), 54 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 eb08f971dc..9e31761773 100644 --- a/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc +++ b/antora/components/comguide/modules/ROOT/pages/cutting-a-release.adoc @@ -177,7 +177,7 @@ sh preview.sh NOTE: this now runs `mvnd clean install -pl core/config` automatically. -Check for any Asciidoc errors, and fix. +Check for any AsciiDoc errors, and fix. Also double-check that the config property files are correctly formatted. diff --git a/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc b/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc index f5f43f9eb5..81697170f7 100644 --- a/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc +++ b/antora/components/comguide/modules/ROOT/pages/post-release-successful.adoc @@ -131,7 +131,7 @@ In the main `causeway` repo (ie containing the asciidoc source): * Generate release notes + -From the root directory, generate the release notes for the current release, in Asciidoc format; eg: +From the root directory, generate the release notes for the current release, in AsciiDoc format; eg: + [source,bash,subs="attributes+"] ---- diff --git a/antora/components/conguide/modules/documentation/nav.adoc b/antora/components/conguide/modules/documentation/nav.adoc index 2502f6f800..b4b82332fe 100644 --- a/antora/components/conguide/modules/documentation/nav.adoc +++ b/antora/components/conguide/modules/documentation/nav.adoc @@ -4,5 +4,5 @@ * xref:conguide:documentation:about.adoc[Documentation] ** xref:conguide:documentation:building-docs-and-website.adoc[Building Docs and Website] ** xref:conguide:documentation:tooling.adoc[Tooling] -** xref:conguide:documentation:asciidoc-syntax.adoc[Asciidoc Syntax] +** xref:conguide:documentation:asciidoc-syntax.adoc[AsciiDoc Syntax] diff --git a/antora/components/conguide/modules/documentation/pages/asciidoc-syntax.adoc b/antora/components/conguide/modules/documentation/pages/asciidoc-syntax.adoc index 4bd63a930a..2111ce4061 100644 --- a/antora/components/conguide/modules/documentation/pages/asciidoc-syntax.adoc +++ b/antora/components/conguide/modules/documentation/pages/asciidoc-syntax.adoc @@ -1,10 +1,10 @@ -= Asciidoc Syntax += AsciiDoc Syntax :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] :page-partial: -This page describes the main syntax conventions when writing Asciidoctor/Asciidoc. +This page describes the main syntax conventions when writing Asciidoctor/AsciiDoc. For more info, see: @@ -96,7 +96,7 @@ Let the markup specify the logical indentation. .Start each sentence on a new line **** Don't worry about wrapping sentences at 80 characters, just start each new sentence on a new line. -Asciidoc will take care of the rendering. +AsciiDoc will take care of the rendering. This simple tip has a number of other benefits: @@ -278,14 +278,14 @@ renders as: where: * the `cols` attribute says how many columns there are and their respective widths. -* the "a" suffix indicates that the contents is parsed as Asciidoc +* the "a" suffix indicates that the contents is parsed as AsciiDoc === Column Attributes Other options are (link:http://mrhaki.blogspot.co.uk/2014/11/awesome-asciidoctor-styling-columns-and.html[credit]): * e: emphasized -* a: Asciidoc markup +* a: AsciiDoc markup * m: monospace * h: header style, all column values are styled as header * s: strong @@ -299,7 +299,7 @@ For example: .Table with column style e,a,m [cols="e,a,m"] |=== -| Emphasized (e) | Asciidoc (a) | Monospaced (m) +| Emphasized (e) | AsciiDoc (a) | Monospaced (m) | Asciidoctor | NOTE: *Awesome* way to write documentation @@ -313,7 +313,7 @@ renders as .Table with column style e,a,m [cols="e,a,m"] |=== -| Emphasized (e) | Asciidoc (a) | Monospaced (m) +| Emphasized (e) | AsciiDoc (a) | Monospaced (m) | Asciidoctor | NOTE: *Awesome* way to write documentation diff --git a/antora/components/conguide/modules/documentation/pages/building-docs-and-website.adoc b/antora/components/conguide/modules/documentation/pages/building-docs-and-website.adoc index 48632e858e..4ed6f2a1b9 100644 --- a/antora/components/conguide/modules/documentation/pages/building-docs-and-website.adoc +++ b/antora/components/conguide/modules/documentation/pages/building-docs-and-website.adoc @@ -2,7 +2,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] -The Apache Causeway website and documentation are written in link:https://asciidoctor.org/[Asciidoc], using link:https://antora.org/[Antora] as a static website generator. +The Apache Causeway website and documentation are written in link:https://asciidoctor.org/[AsciiDoc], using link:https://antora.org/[Antora] as a static website generator. == Prerequisites: @@ -32,7 +32,7 @@ See the link:https://docs.antora.org/antora/2.3/install/install-antora/[Antora d npm i -g serve@^13.0.2 ---- -We also generate some Asciidoc files dynamically from other source code. +We also generate some AsciiDoc files dynamically from other source code. This requires: * link:https://groovy.apache.org/download.html[Groovy 2.x] @@ -63,10 +63,10 @@ sudo apt install dos2unix To create/update documentation, we strongly recommend: -* IntelliJ link:https://plugins.jetbrains.com/plugin/7391-asciidoc[Asciidoc plugin] +* IntelliJ link:https://plugins.jetbrains.com/plugin/7391-asciidoc[AsciiDoc plugin] * IntelliJ link:https://plugins.jetbrains.com/plugin/15635-diagrams-net-integration[Diagrams.net plugin] -Even if you don't use IntelliJ as your primary IDE, it's worth using it for writing documentation - there's currently nothing as good as the Asciidoc plugin on any other editor platform, especially when it comes to writing Antora. +Even if you don't use IntelliJ as your primary IDE, it's worth using it for writing documentation - there's currently nothing as good as the AsciiDoc plugin on any other editor platform, especially when it comes to writing Antora. == Build diff --git a/antora/components/docs/modules/referenceapp/pages/about.adoc b/antora/components/docs/modules/referenceapp/pages/about.adoc index 06b8a518cc..ce0fa962c0 100644 --- a/antora/components/docs/modules/referenceapp/pages/about.adoc +++ b/antora/components/docs/modules/referenceapp/pages/about.adoc @@ -70,4 +70,4 @@ The source code for the reference app is on github, at link:https://github.com/a link:https://www.flaticon.com/authors/smashicons[Smashicons]. These are licensed by link:http://creativecommons.org/licenses/by/3.0/[Creative Commons BY 3.0^] -* We use link:https://github.com/asciidoctor/asciidoctorj[AsciidoctorJ] for Asciidoc rendering. +* We use link:https://github.com/asciidoctor/asciidoctorj[AsciidoctorJ] for AsciiDoc rendering. diff --git a/antora/components/refguide/modules/applib-svc/partials/_metadata-api.adoc b/antora/components/refguide/modules/applib-svc/partials/_metadata-api.adoc index 1314b35bdd..814b69e60f 100644 --- a/antora/components/refguide/modules/applib-svc/partials/_metadata-api.adoc +++ b/antora/components/refguide/modules/applib-svc/partials/_metadata-api.adoc @@ -30,7 +30,7 @@ xref:refguide:applib:index/services/layout/LayoutServiceMenu.adoc[LayoutServiceM |xref:refguide:applib:index/services/sitemap/SitemapService.adoc[SitemapService] & xref:refguide:applib:index/services/sitemap/SitemapServiceMenu.adoc[SitemapServiceMenu] -|Access to a downloadable site map of the application's features, as an Asciidoc document. +|Access to a downloadable site map of the application's features, as an AsciiDoc document. The intention is to use this as the basis for a user guide or to develop a manual regression test plan. diff --git a/antora/components/relnotes/modules/ROOT/pages/2020/2.0.0-M3/relnotes.adoc b/antora/components/relnotes/modules/ROOT/pages/2020/2.0.0-M3/relnotes.adoc index e6cb9aa669..4860213743 100644 --- a/antora/components/relnotes/modules/ROOT/pages/2020/2.0.0-M3/relnotes.adoc +++ b/antora/components/relnotes/modules/ROOT/pages/2020/2.0.0-M3/relnotes.adoc @@ -22,7 +22,7 @@ This milestone also introduces a number of new features: * New value types: ** text-based value type with simple xref:vw:sse:about.adoc[SSE support] -** xref:valuetypes:asciidoc:about.adoc[Asciidoc] value type +** xref:valuetypes:asciidoc:about.adoc[AsciiDoc] value type ** xref:valuetypes:markdown:about.adoc[Markdown] value type * New extensions: diff --git a/antora/components/relnotes/modules/ROOT/pages/2020/2.0.0-M4/relnotes.adoc b/antora/components/relnotes/modules/ROOT/pages/2020/2.0.0-M4/relnotes.adoc index 5a7cb2dbca..ecbe3931d1 100644 --- a/antora/components/relnotes/modules/ROOT/pages/2020/2.0.0-M4/relnotes.adoc +++ b/antora/components/relnotes/modules/ROOT/pages/2020/2.0.0-M4/relnotes.adoc @@ -13,7 +13,7 @@ The release includes support for a new (additional) link:https://cwiki.apache.or On the flip side, support for contributed actions from domain services has been removed; use xref:refguide:applib-classes:mixees-and-mixins.adoc[Mixins]instead. This release also has a reworking/simplification of the command service and background commands. -This includes new extension modules to persist commands (xref:userguide:commandlog:about.adoc[Command Log]. +This includes new extension modules to persist commands (xref:userguide:commandlog:about.adoc[Command Log]). // commandreplay moved to incubator for the time being //and xref:userguide:commandreplay:about.adoc[Command Replay], to assist regression testing. diff --git a/antora/components/relnotes/modules/ROOT/pages/2023/2.0.0-RC3/mignotes.adoc b/antora/components/relnotes/modules/ROOT/pages/2023/2.0.0-RC3/mignotes.adoc index 78e98a8714..0fc8e66e5f 100644 --- a/antora/components/relnotes/modules/ROOT/pages/2023/2.0.0-RC3/mignotes.adoc +++ b/antora/components/relnotes/modules/ROOT/pages/2023/2.0.0-RC3/mignotes.adoc @@ -3,7 +3,6 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] :page-partial: -This page will be added to as development progresses. == Programming Model @@ -21,7 +20,7 @@ As previously marked deprecated for removal: === YamlUtils -Expression of the global tag that contained the DTO class name was removed. +Expression of the global tag that contained the DTO class name was removed. The yaml file will not start with `!!mypackage.Person` (or similar) anymore. see https://medium.com/@snyksec/snakeyaml-2-0-solving-the-unsafe-deserialization-vulnerability-c29a0f08f152 @@ -31,12 +30,12 @@ see https://medium.com/@snyksec/snakeyaml-2-0-solving-the-unsafe-deserialization === docgen Package -`org.apache.causeway.extensions.docgen` +`org.apache.causeway.extensions.docgen` moved to `org.apache.causeway.extensions.docgen.help`. Module entry point -`org.apache.causeway.extensions.docgen.CausewayModuleExtDocgen` +`org.apache.causeway.extensions.docgen.CausewayModuleExtDocgen` moved to `org.apache.causeway.extensions.docgen.help.CausewayModuleExtDocgenHelp`. @@ -80,7 +79,7 @@ moved to === CausewayModuleExtExcelDownloadWicketUi -Was relocated from +Was relocated from `org.apache.causeway.extensions.viewer.wicket.exceldownload.ui.CausewayModuleExtExcelDownloadWicketUi` to `org.apache.causeway.extensions.exceldownload.wkt.ui.CausewayModuleExtExcelDownloadWicketUi` diff --git a/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/mignotes.adoc b/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/mignotes.adoc index 305b7be489..be6368faeb 100644 --- a/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/mignotes.adoc +++ b/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/mignotes.adoc @@ -3,7 +3,6 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] :page-partial: -This page will be added to as development progresses. == Programming Model (CAUSEWAY-3697) @@ -80,7 +79,8 @@ For more details, see link:https://issues.apache.org/jira/browse/CAUSEWAY-3675[C == Mavendeps webapp module and the GraphQL viewer (CAUSEWAY-3676) The GraphQL viewer is a brand new viewer, automatically exposing your domain object model as a GraphQL API. -For more on this new feature, see the corresponding xref:relnotes::2024/2.0.0/relnotes.adoc#the-graphql-viewer-causeway-3676[release notes]. +The documentation can be found xref:gqlv:ROOT:about.adoc[here]. + As part of this work, the `org.apache.causeway.mavendeps:causeway-mavendeps-webapp` convenience module has been updated. It now references all 3 viewers (Wicket, Restful and GraphQL) as a one-stop shop for bringing in viewers. @@ -97,3 +97,4 @@ It now references all 3 viewers (Wicket, Restful and GraphQL) as a one-stop shop It is still necessary to add in the persistence and security modules. For more details, see link:https://issues.apache.org/jira/browse/CAUSEWAY-3676[CAUSEWAY-3676]. + diff --git a/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/relnotes.adoc b/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/relnotes.adoc index 2109c95e74..591b4027b4 100644 --- a/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/relnotes.adoc +++ b/antora/components/relnotes/modules/ROOT/pages/2024/2.0.0/relnotes.adoc @@ -7,14 +7,7 @@ NOTE: Not yet released. -[#the-graphql-viewer-causeway-3676] -== The GraphQL viewer (CAUSEWAY-3676) +After almost six years effort (!), v2.0.0 and v3.0.0 are the first official releases of Apache Causeway, now re-platformed to run on Spring Boot. +The two versions are being released at the same time. -The GraphQL viewer is a brand new viewer which automatically exposes your domain object model as a GraphQL API. - -Built using link:https://spring.io/projects/spring-graphql[Spring for GraphQL], it provides a GraphQL API - -It is important to know that the generated API (in this first release) deliberately -conformant to one of the rueles - -The documentation can be found xref:gqlv:ROOT:about.adoc[here]. -See also link:https://issues.apache.org/jira/browse/CAUSEWAY-3676[CAUSEWAY-3676]. +include::partial$2024/2.0.0/_relnotes.adoc[] diff --git a/antora/components/relnotes/modules/ROOT/pages/2024/3.0.0/mignotes.adoc b/antora/components/relnotes/modules/ROOT/pages/2024/3.0.0/mignotes.adoc new file mode 100644 index 0000000000..3406319746 --- /dev/null +++ b/antora/components/relnotes/modules/ROOT/pages/2024/3.0.0/mignotes.adoc @@ -0,0 +1,35 @@ += Migrating from 2.0.0 to 3.0.0 + +:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] +:page-partial: + + +To upgrade from v2.0 to v3.0: + +* move up to Java 17 (minimum) +* update namespaces from `javax` to `jakarta` +* if you are using the xref:security:shiro:about.adoc[Shiro security] module, this will need to choose a different security implementation. + +This last point is discussed xref:#simple-security-replacement-for-shiro[below]. + +[#simple-security-replacement-for-shiro] +== Simple Security, Replacement for Shiro (link:https://issues.apache.org/jira/browse/CAUSEWAY-3698[CAUSEWAY-3698]) + +In 3.0.0, the Shiro modules are no longer distributed because Apache Shiro have not yet released a `jakarta` namespaced version of their framework. + + +There are several migration options: + +* first is to leverage xref:security:spring:about.adoc[Spring Security]. ++ +This can be extended in various ways, eg for xref:security:spring-oauth2:about.adoc[OAuth2] support. +It is commonly paired with xref:security:secman:about.adoc[SecMan] for authorization + +* or, use xref:security:secman:about.adoc[SecMan] for both authentication and authorization + +* or, use xref:security:simple:about.adoc[Simple Security] which provides a programmatic approach for implementing an `Authenticator` and/or `Authorizor`. ++ +It is broadly equivalent to the Shiro `.ini` realm. + +We will revisit this as and when Apache Shiro release a suitable version of their framework. + diff --git a/antora/components/relnotes/modules/ROOT/pages/2024/3.0.0/relnotes.adoc b/antora/components/relnotes/modules/ROOT/pages/2024/3.0.0/relnotes.adoc new file mode 100644 index 0000000000..dbcd85dff7 --- /dev/null +++ b/antora/components/relnotes/modules/ROOT/pages/2024/3.0.0/relnotes.adoc @@ -0,0 +1,32 @@ +[[r3.0.0]] += 3.0.0 + +:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] +:page-partial: + + +After almost six years effort (!), v2.0.0 and v3.0.0 are the first official releases of Apache Causeway, now re-platformed to run on Spring Boot. +The two versions are being released at the same time. + + +The v3.0.0 release is broadly equivalent to the v2.0.0 release. +As such, see the xref:2024/2.0.0/relnotes.adoc[2.0.0] release notes for full details of the features available in this release. + +However, 3.0.0: + +* targets Spring Boot 3.x (instead of Spring Boot 2.x) +* targets Java 17 (instead of Java 11) + +It also uses the `jakarta` namespace rather than `javax`. + +You should generally use + + +There is one functional change, namely that support for xref:security:shiro:about.adoc[Shiro security] module has been dropped (for now). +See the xref:relnotes:ROOT:2024/3.0.0/mignotes.adoc#simple-security-replacement-for-shiro[migration notes] for options. + + + +NOTE: Not yet released. + +include::partial$2024/2.0.0/_relnotes.adoc[] diff --git a/antora/components/relnotes/modules/ROOT/pages/about.adoc b/antora/components/relnotes/modules/ROOT/pages/about.adoc index d368d9afaf..37cb0a5dbb 100644 --- a/antora/components/relnotes/modules/ROOT/pages/about.adoc +++ b/antora/components/relnotes/modules/ROOT/pages/about.adoc @@ -4,7 +4,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] -This table summarises all releases of Apache Causeway v2.0 to date. +This table summarises all releases of Apache Causeway to date. [cols="2,2,4a,>1,>1,>1,3a"] |=== @@ -16,19 +16,24 @@ This table summarises all releases of Apache Causeway v2.0 to date. | Bugs | Detail -| 2.0.0 -| _tba_ -| Release of Apache Causeway 2.0.0. -| _tba_ +| 3.0.0 | _tba_ +| Release of Apache Causeway 3.0.0 +.2+| 5 +.2+| 25 +.2+| 12 +.2+| +* xref:relnotes:ROOT:2024/3.0.0/relnotes.adoc[Release Notes] +* xref:relnotes:ROOT:2024/3.0.0/mignotes.adoc[3.0.0 Migration Notes] +* xref:relnotes:ROOT:2024/2.0.0/mignotes.adoc[2.0.0 Migration Notes] + +| 2.0.0 | _tba_ -| -* xref:relnotes:ROOT:2024/2.0.0/relnotes.adoc[Release Notes] -* xref:relnotes:ROOT:2024/2.0.0/mignotes.adoc[Migration Notes] +| Release of Apache Causeway 2.0.0 | 2.0.0-RC4 | 2nd Jan 2024 -| Fourth release candidate for Apache Causeway 2.0.0. +| Fourth release candidate for Apache Causeway 2.0.0 | 4 | 11 | 18 @@ -38,7 +43,7 @@ This table summarises all releases of Apache Causeway v2.0 to date. | 2.0.0-RC3 | 9th Oct 2023 -| Third release candidate for Apache Causeway 2.0.0. +| Third release candidate for Apache Causeway 2.0.0 | 19 | 40 | 28 @@ -48,7 +53,7 @@ This table summarises all releases of Apache Causeway v2.0 to date. | 2.0.0-RC2 | 13-Jul-2023 -| Second release candidate for Apache Causeway 2.0.0. +| Second release candidate for Apache Causeway 2.0.0 | 6 | 17 | 44 @@ -58,7 +63,8 @@ This table summarises all releases of Apache Causeway v2.0 to date. | 2.0.0-RC1 | 25-Mar-2023 -| First release candidate for Apache Causeway 2.0.0. Project renamed. +| First release candidate for Apache Causeway 2.0.0 +Project renamed. | 16 | 13 | 39 diff --git a/antora/components/relnotes/modules/ROOT/partials/2024/2.0.0/_relnotes.adoc b/antora/components/relnotes/modules/ROOT/partials/2024/2.0.0/_relnotes.adoc new file mode 100644 index 0000000000..0d8f8afea7 --- /dev/null +++ b/antora/components/relnotes/modules/ROOT/partials/2024/2.0.0/_relnotes.adoc @@ -0,0 +1,186 @@ + +:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] +:page-partial: + + + + +.Comparing v2.0.0 and v3.0.0 +[cols=">2a,^1m,^1m,2a", options="header"] +|=== + +| +| v2.0.0 +| v3.0.0 +| Notes + +| Java +| 11 +| 17 +| + +| Spring Boot +| v2.7.18 +| v3.2.4 +| Spring Boot 2.7 is EOL. + +| Namespace +| javax.* +| jakarta.* +| + +| Wicket +| v9.17.0 +| v10.0.0 +.2+| xref:vw:ROOT:about.adoc[Wicket viewer] + +| Bootstrap +| 5.3.2 +| 5.3.3 + +| RestEasy +| 5.0.0.Final +| 6.2.7.Final +| xref:vro:ROOT:about.adoc[Restful Objects viewer] + +| EclipseLink +| 6.0.7 +| 6.0.7 +| xref:pjdo::about.adoc[] + +| DataNucleus +| 6.0.7 +| 6.0.7 +| xref:pjdo::about.adoc[] + +|=== + + +Other highlights + +* xref:pjpa:ROOT:about.adoc[Persistence using JPA] has been added through an integration of EclipseLink. ++ +xref:pjdo::about.adoc[Persistence using JDO] continues to be supported through the integration with DataNucleus. ++ +[NOTE] +==== +We use EclipseLink rather than Hibernate because the latter is licensed using LGPL, which is incompatible with ASF licensing. +In addition, EclipseLink is the reference implementation for JPA. +==== + ++ +Spring Data is supported for both persistence mechanisms. + +* multiple mechanisms of implementing view models (JAXB, programmatic, serializable). +This is pluggable. + +* added a generic xref:gqlv:ROOT:about.adoc[GraphQL] API. + +* multiple improvements to the programming model, including: + +** support for meta-annotations + +** support for different introspection modes. ++ +In particular, "encapsulated" mode mean that the properties and collections of entities and view models do _not_ have to have `public` visibility; their programmatic API can be kept to a minimum. + +** supported custom scalar value types and composite types ++ +This includes xref:valuetypes:asciidoc:about.adoc[AsciiDoc], xref:valuetypes:markdown:about.adoc[Markdown], xref:valuetypes:jodatime:about.adoc[] and xref:valuetypes:vega:about.adoc[Vega] (link:https://vega.github.io/vega-lite/[Vega-lite], "a grammar of interactive graphics"). + +** mixin classes annotated as `@Action`, `@Property` or `@Collection` + +** logical type name aliases + +* integration extensions, including xref:userguide:commandlog:about.adoc[], xref:userguide:executionlog:about.adoc[] and xref:userguide:executionoutbox:about.adoc[] + +* xref:vw:ROOT:about.adoc[] extensions including xref:vw:fullcalendar:about.adoc[], xref:vw:pdfjs:about.adoc[], xref:vw:tabular:about.adoc[Tabular Extension] (Excel). ++ +Also tree view and client-side filtering using datatables.net JS. + +* security extensions including xref:security:secman:about.adoc[secman] ( authorization and/or authentication implemented as Causeway entities), xref:security:audittrail:about.adoc[Audit Trail] and xref:security:sessionlog:about.adoc[Session Log] + +* dependency/library upgrades: + +** Spring event bus replaces guava or axon; removes guice + +** ByteBuddy replaces cglib or javassist for implementation of xref:refguide:applib:index/services/wrapper/WrapperFactory.adoc[] + +** switch from hsqldb to h2 + +* other extensions such as a xref:refguide:extensions:index/commandlog/applib/dom/BackgroundService.adoc[BackgroundService] for executing commands asynchronously, and xref:userguide:flyway:about.adoc[] integration. + +Apart from dependencies and the `javax`/`jakarta` namespace, in most regards v2.0.0 and v3.0 are functionally equivalent. +The only feature not available in 3.0 is the Shiro module, because (at the time of release) Apache Shiro have not released `jakarta` support. +However, either the xref:security:spring:about.adoc[Spring Security] integration or even the xref:security:simple:about.adoc[Simple Security] implementation can be used instead. + +--- +For `2.0.0` itself, below is the list of features, improvements and bugs made since `2.0.0-RC4`. + + + +== New Feature + +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3698[CAUSEWAY-3698] - Security Integration Replacement for Shiro INI based Realm (xref:security:simple:about.adoc[]) +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3676[CAUSEWAY-3676] - GraphQL viewer (xref:gqlv:ROOT:about.adoc[]) +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3671[CAUSEWAY-3671] - `Object_createdByCommand` +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3670[CAUSEWAY-3670] - Extend BookmarkService with better support of logical type name aliases +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3669[CAUSEWAY-3669] - Extend `CausewayConfiguration` to return all config keys and their value + + +== Improvement + +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3700[CAUSEWAY-3700] - Include the secman authenticator auto-configuration... +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3697[CAUSEWAY-3697] - Deprecate `@DomainService(nature=NatureOfService..)` for Removal (to be replaced by some SPI) +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3696[CAUSEWAY-3696] - Don't log ``ClientAbortException``s +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3694[CAUSEWAY-3694] - IntrospectionPolicy `ENCAPSULATION_ENABLED` should NOT require annotation on mixin main method. +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3693[CAUSEWAY-3693] - [Wicket Viewer] Allow table header text to break on whitespace (CSS) +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3692[CAUSEWAY-3692] - [Programming Model] Rename `DependentDefaultsPolicy` to `PrecedingParamsPolicy` to better explain intent. +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3691[CAUSEWAY-3691] - [JUnit] Remove 'stable' from regression test artifact names +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3689[CAUSEWAY-3689] - Make parsing of `BigDecimal` stricter, to avoid mistypes. +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3688[CAUSEWAY-3688] - Audit trail should gracefully _attempt_ to capture values, but not fail fast. +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3687[CAUSEWAY-3687] - [Validation] Disallow `@Transactional` within @DomainService(nature=VIEW) +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3686[CAUSEWAY-3686] - [Wicket Viewer] Veto (Reason) Icon Tooltip is potentially too verbose +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3685[CAUSEWAY-3685] - Tree Rendering: allow for nodes to be marked (as selected) +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3684[CAUSEWAY-3684] - [Commons] Json/YamlUtils support for `Can<T>` +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3683[CAUSEWAY-3683] - [Commons] Json/YamlUtils support for `java.time` (ISO) +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3678[CAUSEWAY-3678] - REST API should return a 503 if polled before the app is fully up. +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3675[CAUSEWAY-3675] - Suppress autoflush if called by `EntityChangeTracker` (to avoid concurrent modification exceptions). +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3672[CAUSEWAY-3672] - Make `DomainEventHelper` more resilient if there is a programming error with the definition of an event. +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3661[CAUSEWAY-3661] - REST call for collection can return 404 error +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3646[CAUSEWAY-3646] - [Programming Model] Object Support Method for Font Awesome Layers +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3461[CAUSEWAY-3461] - [Wicket Viewer] unable to tab into `autoComplete` search field. +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3404[CAUSEWAY-3404] - [Commons] Quality of Life Improvements for 2.0.0 Release +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3390[CAUSEWAY-3390] - `AuditTrailEntryRepository` has generic parameter vs secman repos (eg `ApplicationUserRepository`) that does not ... make these consistent. +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3081[CAUSEWAY-3081] - Check for existence of feature in fixturescript +* link:https://issues.apache.org/jira/browse/CAUSEWAY-2873[CAUSEWAY-2873] - petclinic tutorial (documentation) +* link:https://issues.apache.org/jira/browse/CAUSEWAY-2085[CAUSEWAY-2085] - [archunit rule] Every entity should be annotated with `@XmlJavaTypeAdapter(PersistentEntityAdapter.class)` + + +== Bug + +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3701[CAUSEWAY-3701] - Enable h2 ui console for v3 +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3679[CAUSEWAY-3679] - Downloaded Excel spreadsheet shows header rows as black on black. +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3674[CAUSEWAY-3674] - [Wicket Viewer] Potential NPE in `PendingParamsSnapshot` +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3673[CAUSEWAY-3673] - Fix `LayoutLoadersGitHubMenu` action's incorrectly defined domain event. +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3667[CAUSEWAY-3667] - [Wicket Viewer] Regression: date/time picker in param dialog is squeezed into single line +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3650[CAUSEWAY-3650] - `FixtureScripts` `runScript` vs `runFixtureScript` - one fires the `FixturesInstallingEvent`/`FixturesInstalledEvent` and the other does not. +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3620[CAUSEWAY-3620] - RO viewer returns 500 not 404 if object doesn't exist. +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3491[CAUSEWAY-3491] - [Wicket Viewer] cannot easily change the offset for an `OffsetTime` +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3490[CAUSEWAY-3490] - [Wicket Viewer] not possible to change the offset for an `OffsetDateTime`. +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3489[CAUSEWAY-3489] - [Wicket Viewer] cannot enter ZonedDateTime values and Joda `DateTime`. +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3326[CAUSEWAY-3326] - ``Specification``'s Injection Points are not being resolved +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3175[CAUSEWAY-3175] - Autocomplete not supported for values, only for object references + + +== Duplicate +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3695[CAUSEWAY-3695] - [DUPLICATE] Joda DateTime not being handled correctly - treated as a ZonedDateTime + +== Documentation + +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3677[CAUSEWAY-3677] - get to green on website checks - https://whimsy.apache.org/site/ + + +== Task + +* link:https://issues.apache.org/jira/browse/CAUSEWAY-3666[CAUSEWAY-3666] - 2.0.0 release activities diff --git a/antora/components/userguide/modules/ROOT/pages/overview.adoc b/antora/components/userguide/modules/ROOT/pages/overview.adoc index b44588ac6d..8a0494bfbe 100644 --- a/antora/components/userguide/modules/ROOT/pages/overview.adoc +++ b/antora/components/userguide/modules/ROOT/pages/overview.adoc @@ -16,7 +16,7 @@ These will be either a xref:domain-entities.adoc[domain entity] (persisted state To access them, a menu xref:domain-services.adoc[domain service] will be used to find from the database (a repository service) or occasionally to create a new instance (a factory service). The state managed by entities and view models is expressed in terms of xref:properties-collections-actions.adoc[properties and collections], with properties whose value either refers to other domain objects (reference types) or alternatively holds a value directly (xref:value-types.adoc[value types]). -Apache Causeway supports a wide variety of xref:value-types.adoc[value types], including JDK types (primitives, strings or dates) Causeway-specific (eg Asciidoc, Vega) and 3rd party (eg Jodatime). +Apache Causeway supports a wide variety of xref:value-types.adoc[value types], including JDK types (primitives, strings or dates) Causeway-specific (eg AsciiDoc, Vega) and 3rd party (eg Jodatime). Moreover it is possible to define your own custom types, and you can teach the framework about other 3rd party libraries you might wish to use, eg https://jscience.org[JScience]. Actions allow the end-user to invoke business logic. diff --git a/antora/components/userguide/modules/ROOT/pages/value-types.adoc b/antora/components/userguide/modules/ROOT/pages/value-types.adoc index 867dc03777..a08e3ddf90 100644 --- a/antora/components/userguide/modules/ROOT/pages/value-types.adoc +++ b/antora/components/userguide/modules/ROOT/pages/value-types.adoc @@ -10,7 +10,7 @@ The state managed by entities and view models is expressed in terms of xref:prop This latter is the topic of this page. -Apache Causeway supports a wide variety of value types, including JDK types (eg primitives, dates and `String`) Causeway-specific (eg `Asciidoc`, `Vega`) and 3rd party (eg Joda Time). +Apache Causeway supports a wide variety of value types, including JDK types (eg primitives, dates and `String`) Causeway-specific (eg `AsciiDoc`, `Vega`) and 3rd party (eg Joda Time). Moreover it is possible to define your own custom types. You can even teach the framework about other 3rd party libraries you might wish to use. diff --git a/core/adoc/modules/ROOT/pages/about.adoc b/core/adoc/modules/ROOT/pages/about.adoc index ceff597e8f..60264bf643 100644 --- a/core/adoc/modules/ROOT/pages/about.adoc +++ b/core/adoc/modules/ROOT/pages/about.adoc @@ -60,7 +60,7 @@ There are also two `core` modules not listed above, because their documentation [#generated-index] == Generated Index -This is probably a good place as any to mention that the documentation/website procedures include tooling to automatically create Asciidoc reference documentation for _any_ Java class in the codebase. +This is probably a good place as any to mention that the documentation/website procedures include tooling to automatically create AsciiDoc reference documentation for _any_ Java class in the codebase. This is used extensively for the classes in the applib; these can be referenced using the form `\xref:refguide:applib:index/xxx.adoc[]`. diff --git a/extensions/vw/sse/adoc/modules/sse/pages/about.adoc b/extensions/vw/sse/adoc/modules/sse/pages/about.adoc index 986b249755..3927ba33aa 100644 --- a/extensions/vw/sse/adoc/modules/sse/pages/about.adoc +++ b/extensions/vw/sse/adoc/modules/sse/pages/about.adoc @@ -2,7 +2,7 @@ :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] -The SSE (Server Side Events) module integrates with the xref:vw:ROOT:about.adoc[Wicket Viewer], and provides the ability to dynamically update properties of type xref:valuetypes:markdown:about.adoc[Markdown] and xref:valuetypes:asciidoc:about.adoc[Asciidoc]. +The SSE (Server Side Events) module integrates with the xref:vw:ROOT:about.adoc[Wicket Viewer], and provides the ability to dynamically update properties of type xref:valuetypes:markdown:about.adoc[Markdown] and xref:valuetypes:asciidoc:about.adoc[AsciiDoc]. One use case could be to render a progress bar for a long-running action. diff --git a/tooling/cli/adoc/modules/tooling-cli/pages/about.adoc b/tooling/cli/adoc/modules/tooling-cli/pages/about.adoc index a399392851..b2fbfbb473 100644 --- a/tooling/cli/adoc/modules/tooling-cli/pages/about.adoc +++ b/tooling/cli/adoc/modules/tooling-cli/pages/about.adoc @@ -235,7 +235,7 @@ This command generates the _Document Global Index_ (`.adoc`) files. Any class found with magic `{@index}` in its _java-doc_ section at type level, will be included with the _Document Global Index_. -Asciidoc files may refer to the _Document Global Index_ via `xref` or `include` statements using paths such as `refguide:applib:index/annotation/Xxx.adoc`. +AsciiDoc files may refer to the _Document Global Index_ via `xref` or `include` statements using paths such as `refguide:applib:index/annotation/Xxx.adoc`. ==== Usage diff --git a/valuetypes/asciidoc/adoc/modules/asciidoc/pages/about.adoc b/valuetypes/asciidoc/adoc/modules/asciidoc/pages/about.adoc index 1cd2a1cafc..8f9c93697c 100644 --- a/valuetypes/asciidoc/adoc/modules/asciidoc/pages/about.adoc +++ b/valuetypes/asciidoc/adoc/modules/asciidoc/pages/about.adoc @@ -1,4 +1,4 @@ -= Asciidoc Extension += AsciiDoc Extension :Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...] diff --git a/valuetypes/asciidoc/adoc/modules/asciidoc/partials/module-nav.adoc b/valuetypes/asciidoc/adoc/modules/asciidoc/partials/module-nav.adoc index f3417acab7..8d2befb0b0 100644 --- a/valuetypes/asciidoc/adoc/modules/asciidoc/partials/module-nav.adoc +++ b/valuetypes/asciidoc/adoc/modules/asciidoc/partials/module-nav.adoc @@ -1,5 +1,5 @@ -* xref:valuetypes:asciidoc:about.adoc[Asciidoc] +* xref:valuetypes:asciidoc:about.adoc[AsciiDoc]
