You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2018/01/04 18:30:48 UTC
[isis] 02/02: ISIS-1465: adds migration notes and release notes for
1.16.0
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 7728fd666a4cd59977d108b770be1a8cbce8a09c
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Thu Jan 4 18:23:21 2018 +0000
ISIS-1465: adds migration notes and release notes for 1.16.0
---
.../_migration-notes_1.15.0-to-1.16.0.adoc | 71 ++++++++++++
.../asciidoc/migration-notes/migration-notes.adoc | 1 +
.../release-notes/_release-notes_1.16.0.adoc | 123 +++++++++++++++++++++
.../main/asciidoc/release-notes/release-notes.adoc | 11 +-
4 files changed, 205 insertions(+), 1 deletion(-)
diff --git a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.15.0-to-1.16.0.adoc b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.15.0-to-1.16.0.adoc
new file mode 100644
index 0000000..d6459c3
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.15.0-to-1.16.0.adoc
@@ -0,0 +1,71 @@
+[[_migration-notes_1.15.0-to-1.16.0]]
+= From v1.15.x to 1.16.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 [...]
+:_basedir: ../
+:_imagesdir: images/
+
+
+
+
+[[_migration-notes_1.15.0-to-1.16.0_app-manifest]]
+== `AppManifest2` and `Module`
+
+While not required, it is recommended to rework modules to subclass from `ModuleAbstract`, and to bootstrap the application using `AppManifestAbstract2`.
+
+
+[[_migration-notes_1.15.0-to-1.16.0_integ-testing]]
+== `IntegrationTestAbstract3`
+
+While not required, it is recommended that integration tests are updated to subclass from `IntegrationTestAbstract3`.
+These require a `Module` to bootstrap from (see above).
+
+
+[[_migration-notes_1.15.0-to-1.16.0_explicit-actions]]
+== Explicitly-defined actions
+
+By default actions are implicitly recognised as any remaining `public` methods once properties/collections and supporting methods are discounted.
+Any methods that are _not_ intended to be actions have previously required to be annotated with `@Programmatic`.
+
+Setting:
+
+[source,ini]
+----
+isis.reflector.explicitAnnotations.action=true
+----
+
+reverses this policy: left-over `public` methods will not be treated as actions unless they also have an `@Action` annotation.
+
+
+
+[[_migration-notes_1.15.0-to-1.16.0_isis-mavendeps]]
+== `isis-mavendeps-intellij` Aggregator POM
+
+The contents of the `org.apache.isis.mavendeps:isis-mavendeps-intellij` aggregator has been moved to `org.apache.isis.mavendeps:isis-mavendeps-webapp`.
+
+Since these are commonly found together in the webapp module, the `isis-mavendeps-intellij` reference can therefore simply be removed.
+
+Note that `isis-mavendeps-webapp` has been updated with support for running within Eclipse IDE.
+
+
+
+[[_migration-notes_1.15.0-to-1.16.0_incode-platform]]
+== (non-ASF) Incode Platform
+
+The generic subdomain modules of the (non-ASF) link:http://platform.incode.org["Incode Platform"] have been demoted to instead act as examples.
+
+Rather than consume as binaries, the recommendation is to copy in the source code into your application and adapt as required.
+
+For the time being, the binaries will continue to be released, but to avoid confusions the `groupId:artifactId` and the packages have been changed.
+
+For example, the _alias_ generic subdomain has moved:
+
+* from: `org.incode.module.alias:incode-module-alias-dom`
+* to: `org.incode.example.alias:incode-example-alias-dom`
+
+The package has similarly changed:
+
+* from: `org.incode.module.alias`
+* to: `org.incode.example.alias`
+
+The full list of generic subdomains that have been renamed to examples is: _alias, classification, commchannel, communications, country, docfragment, document, note, settings_ and _tags_.
+
diff --git a/adocs/documentation/src/main/asciidoc/migration-notes/migration-notes.adoc b/adocs/documentation/src/main/asciidoc/migration-notes/migration-notes.adoc
index f52a613..1e38b3a 100644
--- a/adocs/documentation/src/main/asciidoc/migration-notes/migration-notes.adoc
+++ b/adocs/documentation/src/main/asciidoc/migration-notes/migration-notes.adoc
@@ -10,6 +10,7 @@ Consult these notes when migrating to new versions of the framework.
+include::_migration-notes_1.15.0-to-1.16.0.adoc[leveloffset=+1]
include::_migration-notes_1.14.0-to-1.15.0.adoc[leveloffset=+1]
include::_migration-notes_1.13.0-to-1.14.0.adoc[leveloffset=+1]
include::_migration-notes_1.12.0-to-1.13.0.adoc[leveloffset=+1]
diff --git a/adocs/documentation/src/main/asciidoc/release-notes/_release-notes_1.16.0.adoc b/adocs/documentation/src/main/asciidoc/release-notes/_release-notes_1.16.0.adoc
new file mode 100644
index 0000000..19ed3ed
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/release-notes/_release-notes_1.16.0.adoc
@@ -0,0 +1,123 @@
+[[_release-notes_1.16.0]]
+= 1.16.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 [...]
+:_basedir: ../
+:_imagesdir: images/
+:toc: right
+
+
+
+This release introduces a couple of new features and improvements.
+
+* a new `Module` interface (and `ModuleAbstract` adapter class) allows transitive dependencies to be defined between modules, and allowing optional setup and teardown fixtures to be defined for the module
+
+* Application bootstrapping has been simplified further with a new `AppManifest2` interface (and `AppManifestAbstract2` adapter class) defined in terms of ``Module``s.
+
++
+Similarly, integration testing bootstrapping has been simplified with a new `IntegrationTestAbstract3` adapter class that also uses a `Module`.
+
++
+BDD specs (Cucumber) have also been simplified to be bootstrapped with a `Module`, with a much more "conventional" programming model (domain services can be injected into spec "glue", the same as for integration tests)
+
+* Fixture scripts have been improved (the `BuilderScriptAbstract` subclass) to allow enums to act as "personas".
+An enum instance can be used to easily create corresponding domain objects, and then later to look up that domain object from within a test
+
+* menu bars can now be specified using a `menubars.layout.xml` file, expected to reside in the same package as the app manifest used to bootstrap the application
+
+* The framework can be configured to require that actions are explicitly annotatedusing `@Action`.
+This therefore removes the requirement to annotate non-action methods with `@Programmatic`.
+
+There are also numerous improvements and bug fixes.
+
+Applications written against v1.15.x should run against v1.16.0 with few if any changes.
+However, note that applications *are* required to bootstrap from an `AppManifest`.
+
+
+
+
+
+== New Feature
+
+* link:https://issues.apache.org/jira/browse/ISIS-1801[ISIS-1801] - BookmarkUiService to clear Wicket bookmarks and breadcrumbs programmatically.
+* link:https://issues.apache.org/jira/browse/ISIS-1794[ISIS-1794] - Rework BDD bootstrapping to support app manifest/modules + dependency injection into glue
+* link:https://issues.apache.org/jira/browse/ISIS-1793[ISIS-1793] - Extend MetaModelService to expose the AppManifest used to bootstrap the app
+* link:https://issues.apache.org/jira/browse/ISIS-1792[ISIS-1792] - DtoMappingHelper domain service.
+* link:https://issues.apache.org/jira/browse/ISIS-1791[ISIS-1791] - provide a ClockFixture and TickingClockFixture
+* link:https://issues.apache.org/jira/browse/ISIS-1784[ISIS-1784] - Support for the builder pattern for fixtures, along with more flexibility in fixture setup using BuilderScriptAbstract
+* link:https://issues.apache.org/jira/browse/ISIS-1772[ISIS-1772] - Assume @Programmatic for public methods not annotated with @Action (make this configurable).
+* link:https://issues.apache.org/jira/browse/ISIS-1769[ISIS-1769] - Mixin to navigate to equivalent REST API URL for each domain object.
+* link:https://issues.apache.org/jira/browse/ISIS-1766[ISIS-1766] - Allow Xxx.layout.xml and menu.layout.xml to be served up as JSON via REST API
+* link:https://issues.apache.org/jira/browse/ISIS-1765[ISIS-1765] - Extend menu.layout.xml to include HATEOAS links when served by REST API.
+* link:https://issues.apache.org/jira/browse/ISIS-1764[ISIS-1764] - Expose the "layout" resource for domain objects via REST API, with HATEOAS links.
+* link:https://issues.apache.org/jira/browse/ISIS-1752[ISIS-1752] - Extend RO viewer, return a menu.layout.xml resource
+* link:https://issues.apache.org/jira/browse/ISIS-977[ISIS-977] - Allow the application menus to be specified using a appmenu.layout.xml file.
+
+
+== Improvement
+
+* link:https://issues.apache.org/jira/browse/ISIS-1804[ISIS-1804] - Deprecate isis-mavendeps-intellij, fold into isis-mavendeps-webapp
+* link:https://issues.apache.org/jira/browse/ISIS-1800[ISIS-1800] - Blank out apiKey and authToken when listing configuration properties.
+* link:https://issues.apache.org/jira/browse/ISIS-1798[ISIS-1798] - Error page should suppress stack trace if an ErrorReportingService returns a Ticket indicating stack trace should be hidden
+* link:https://issues.apache.org/jira/browse/ISIS-1797[ISIS-1797] - Error page should show a "Continue" button to go back to previous page.
+* link:https://issues.apache.org/jira/browse/ISIS-1796[ISIS-1796] - Extend info in ErrorDetails for the ErrorReportingService
+* link:https://issues.apache.org/jira/browse/ISIS-1786[ISIS-1786] - Allow the default defaultView for collections to be configured globally.
+* link:https://issues.apache.org/jira/browse/ISIS-1782[ISIS-1782] - Revamp support for bootstrapping using transitive modules
+* link:https://issues.apache.org/jira/browse/ISIS-1778[ISIS-1778] - Handle anonymous classes in the metamodel, and ignore also any explicitly annotated as @Programmatic
+* link:https://issues.apache.org/jira/browse/ISIS-1776[ISIS-1776] - Remove lombok from helloworld, to reduce # of concepts need to understand
+* link:https://issues.apache.org/jira/browse/ISIS-1774[ISIS-1774] - Handle N+1 issue for first page and subsequent pages.
+* link:https://issues.apache.org/jira/browse/ISIS-1771[ISIS-1771] - Restful viewer shows unreadable warnings
+* link:https://issues.apache.org/jira/browse/ISIS-1759[ISIS-1759] - Always calling getXxx() and hideXxx() both decreases performance of application (?)
+* link:https://issues.apache.org/jira/browse/ISIS-1746[ISIS-1746] - Provide a default implementation of UserProfileService so that don't need special case logic in each viewer.
+* link:https://issues.apache.org/jira/browse/ISIS-1729[ISIS-1729] - Auditer Service probably shouldn't submit records for an object that is [new] -> [deleted]
+* link:https://issues.apache.org/jira/browse/ISIS-1728[ISIS-1728] - Rework helloworld and simpleapp to use typesafe queries.
+* link:https://issues.apache.org/jira/browse/ISIS-1700[ISIS-1700] - Enhance ObjectContracts#compare to allow different types of objects to be compared.
+
+
+== Bug
+
+* link:https://issues.apache.org/jira/browse/ISIS-1803[ISIS-1803] - Hitting escape twice on prompt results in the error page.
+* link:https://issues.apache.org/jira/browse/ISIS-1802[ISIS-1802] - JDOQL using SELECT UNIQUE causes NPE to be thrown.
+* link:https://issues.apache.org/jira/browse/ISIS-1799[ISIS-1799] - Extend TransactionService with overload of nextTransaction for more control.
+* link:https://issues.apache.org/jira/browse/ISIS-1795[ISIS-1795] - Error page heading is white-on-white for some themes.
+* link:https://issues.apache.org/jira/browse/ISIS-1789[ISIS-1789] - Metamodel validator thinks SQL query is a JDOQL query and fails
+* link:https://issues.apache.org/jira/browse/ISIS-1787[ISIS-1787] - Property named 'Active' conflicts with Bootstrap CSS class (optional configuration property to set as a prefix on all CSS classes)
+* link:https://issues.apache.org/jira/browse/ISIS-1785[ISIS-1785] - DomainService#menuOrder and DomainServiceLayout#menuOrder are not equivalent
+* link:https://issues.apache.org/jira/browse/ISIS-1783[ISIS-1783] - Prevent classpath scanning from returning services outside the list of (packages of) modules
+* link:https://issues.apache.org/jira/browse/ISIS-1781[ISIS-1781] - JsonValueConverter as implemented for int->long throws class cast exception
+* link:https://issues.apache.org/jira/browse/ISIS-1780[ISIS-1780] - Unable to remove facets (isis.reflector.facets.exclude)
+* link:https://issues.apache.org/jira/browse/ISIS-1777[ISIS-1777] - swagger-ui/index.html in helloworld and simpleapp needs to honor context paths
+* link:https://issues.apache.org/jira/browse/ISIS-1773[ISIS-1773] - default view of a collection seems to be broken
+* link:https://issues.apache.org/jira/browse/ISIS-1770[ISIS-1770] - REST API action resources with _ARE_YOU_SURE result in NPE
+* link:https://issues.apache.org/jira/browse/ISIS-1768[ISIS-1768] - REST API returning 500 not 404 when try to access non-existent object
+* link:https://issues.apache.org/jira/browse/ISIS-1761[ISIS-1761] - Hiding empty fieldset + similar issues with contributed props/colls.
+* link:https://issues.apache.org/jira/browse/ISIS-1758[ISIS-1758] - cssClass() not working any more if css class definition exists on DomainObjectLayout
+* link:https://issues.apache.org/jira/browse/ISIS-1750[ISIS-1750] - SQL Exception when invoke action (inline prompt) not handled correctly in UI
+* link:https://issues.apache.org/jira/browse/ISIS-1749[ISIS-1749] - Allow domain object nature of XXX_ENTITY to be specified for JAXB view models
+* link:https://issues.apache.org/jira/browse/ISIS-1748[ISIS-1748] - Update HelloWorld & Simpleapp archetype to run under Eclipse
+* link:https://issues.apache.org/jira/browse/ISIS-1741[ISIS-1741] - ConcurrentModificationException during startup when launching packaged webapp with jetty
+* link:https://issues.apache.org/jira/browse/ISIS-1739[ISIS-1739] - DisableXxx() method is always called while hideXxx() returns true
+* link:https://issues.apache.org/jira/browse/ISIS-1738[ISIS-1738] - ObjectMember's compator is not transitive
+* link:https://issues.apache.org/jira/browse/ISIS-1730[ISIS-1730] - Invoking an action button which was rendered enabled but which is actually disabled at point of invocation throws stacktrace.
+* link:https://issues.apache.org/jira/browse/ISIS-1714[ISIS-1714] - AppManifestAbstract#withConfigurationProperty overwrites value set by -D system property.
+* link:https://issues.apache.org/jira/browse/ISIS-1710[ISIS-1710] - AppManifestAbstract#withAdditionalServices replaces rather than appends.
+* link:https://issues.apache.org/jira/browse/ISIS-1698[ISIS-1698] - CollectionLayout.defaultView not honored
+
+
+== Documentation only
+
+* link:https://issues.apache.org/jira/browse/ISIS-1747[ISIS-1747] - Update docs, hints-n-tips for view models
+
+
+== Task
+
+* link:https://issues.apache.org/jira/browse/ISIS-1465[ISIS-1465] - Release activities for 1.16.0
+
+
+== Other
+
+* link:https://issues.apache.org/jira/browse/ISIS-383[ISIS-383] - [OUT OF SCOPE] Integrate Apache Lucene or ElasticSearch
+* link:https://issues.apache.org/jira/browse/ISIS-724[ISIS-724] - [WON'T FIX] Support HTML file format as a way of specifying dynamic layout facets (similar to .layout.json files currently)
+* link:https://issues.apache.org/jira/browse/ISIS-814[ISIS-814] - [WON'T FIX] Provide a better way to handle polymorphic relationships, eg implement a "PolymorphicNavigator service"
+* link:https://issues.apache.org/jira/browse/ISIS-1745[ISIS-1745] - [CANNOT REPRODUCE] isis maven plugin (validate) swallows NPEs from DN.
+* link:https://issues.apache.org/jira/browse/ISIS-1760[ISIS-1760] - [NOT A PROBLEM] Integration of Apache Isis and Ignite
+* link:https://issues.apache.org/jira/browse/ISIS-1790[ISIS-1790] - [DUPLICATE] Concurrent modification exception at startup
diff --git a/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc b/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc
index 02a0787..6c09af3 100644
--- a/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc
+++ b/adocs/documentation/src/main/asciidoc/release-notes/release-notes.adoc
@@ -21,13 +21,21 @@ This table summarises all releases of Apache Isis to date.
| Bugs
| JIRA relnotes
+| xref:release-notes.adoc#_release-notes_1.16.0[1.16.0]
+| XX-XX-2018
+| Modules, simplified bootstrapping, menubars.layout.xml
+| 13
+| 16
+| 26
+| https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12311171&version=12342073[Release notes for v1.16.0]
+
| xref:release-notes.adoc#_release-notes_1.15.1[1.15.1]
| 25-09-2017
| Bug fixes, Wicket 7.9.0, Markup valuetype
| 5
| 4
| 9
-| link:https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12311171&version=12341577[Release notes for v1.15.0]
+| link:https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12311171&version=12341577[Release notes for v1.15.1]
| xref:release-notes.adoc#_release-notes_1.15.0[1.15.0]
| 14-08-2017
@@ -297,6 +305,7 @@ This table summarises all releases of Apache Isis to date.
+include::_release-notes_1.16.0.adoc[leveloffset=+1]
include::_release-notes_1.15.1.adoc[leveloffset=+1]
include::_release-notes_1.15.0.adoc[leveloffset=+1]
include::_release-notes_1.14.0.adoc[leveloffset=+1]
--
To stop receiving notification emails like this one, please contact
"commits@isis.apache.org" <co...@isis.apache.org>.