This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch maintenance-branch
in repository https://gitbox.apache.org/repos/asf/causeway.git
The following commit(s) were added to refs/heads/maintenance-branch by this
push:
new 44b91739828 [v2] adds changelog (docs)
44b91739828 is described below
commit 44b91739828a7afeea13982fd286fcad24c5b1ea
Author: andi-huber <[email protected]>
AuthorDate: Mon Jan 19 12:06:08 2026 +0100
[v2] adds changelog (docs)
---
README.adoc | 62 ++++----------------------------------------
adoc/build-instructions.adoc | 35 +++++++++++++++++++++++++
adoc/changelog.adoc | 23 ++++++++++++++++
adoc/ci-instructions.adoc | 23 ++++++++++++++++
4 files changed, 86 insertions(+), 57 deletions(-)
diff --git a/README.adoc b/README.adoc
index fe754ccee33..860019ccdfd 100644
--- a/README.adoc
+++ b/README.adoc
@@ -12,66 +12,14 @@ This branch has vulnerabilities, see
https://www.cve.org/CVERecord?id=CVE-2025-64408[CVE-2025-64408]
====
-== Build your own (Version `2.x`)
+== Changelog (Version `2.x`)
-Here are the recommended build instructions:
+include::adoc/changelog.adoc[leveloffset=2]
-- use sdkman see https://sdkman.io
-- install _Maven 3.9.12_ `sdk install maven 3.9.12`
-- install _Java 25_ `sdk install java 25.0.1-tem`
-- verify Maven and Java versions are as desired: `mvn -v`
+== Build your own (Version `2.x`)
-First we set the desired version:
-----
-mvn versions:set -Drevision=2.2.0-SNAPSHOT
-----
-
-Now build with _mvn_ command:
-----
-mvn install \
- -Drevision=2.2.0-SNAPSHOT \
- -Dmaven.compiler.release=11 \
- -Dmaven.compiler.proc=full \
- -Dmaven.source.skip=true \
- -Dmodule-regressiontests \
- -T 6 \
- -e
-----
-
-Note: the `revision` parameter can be set as desired
-
-== Legacy (isis) Build
-
-Before running the above `mvn install ...` one has to run:
-----
-export ROOT_PATH_LEGACY=$(pwd)
-jshell scripts/ci/rename-all-published-sources.jsh
-----
-
-This will rename artifacts and packages from `causeway` to `isis`.
+include::adoc/build-instructions.adoc[leveloffset=2]
== CI Build using Gitlab
-One can setup a gitlab repository just for the purpose of
-building and deploying _Causeway_ artifacts.
-
-A minimal build script could look like:
-
-[source,yaml]
-..gitlab-ci.yml
-----
-image: maven:3.9.12-eclipse-temurin-25
-
-include:
- - local: ci/causeway-v2.yml
- - local: ci/isis-v2.yml
-
-stages:
- - checkout-patch-deploy
-----
-
-where the actual jobs are declared in their own files in the `ci` directory:
-
-TODO flesh out `ci/causeway-v2.yml`
-
-TODO flesh out `ci/isis-v2.yml`
\ No newline at end of file
+include::adoc/ci-instructions.adoc[leveloffset=2]
\ No newline at end of file
diff --git a/adoc/build-instructions.adoc b/adoc/build-instructions.adoc
new file mode 100644
index 00000000000..c54d600c67f
--- /dev/null
+++ b/adoc/build-instructions.adoc
@@ -0,0 +1,35 @@
+Here are the recommended build instructions:
+
+- use sdkman see https://sdkman.io
+- install _Maven 3.9.12_ `sdk install maven 3.9.12`
+- install _Java 25_ `sdk install java 25.0.1-tem`
+- verify Maven and Java versions are as desired: `mvn -v`
+
+First we set the desired version:
+----
+mvn versions:set -Drevision=2.2.0-SNAPSHOT
+----
+
+Now build with _mvn_ command:
+----
+mvn install \
+ -Drevision=2.2.0-SNAPSHOT \
+ -Dmaven.compiler.release=11 \
+ -Dmaven.compiler.proc=full \
+ -Dmaven.source.skip=true \
+ -Dmodule-regressiontests \
+ -T 6 \
+ -e
+----
+
+Note: the `revision` parameter can be set as desired
+
+== Legacy (isis) Build
+
+Before running the above `mvn install ...` one has to run:
+----
+export ROOT_PATH_LEGACY=$(pwd)
+jshell scripts/ci/rename-all-published-sources.jsh
+----
+
+This will rename artifacts and packages from `causeway` to `isis`.
diff --git a/adoc/changelog.adoc b/adoc/changelog.adoc
new file mode 100644
index 00000000000..cb4be85de74
--- /dev/null
+++ b/adoc/changelog.adoc
@@ -0,0 +1,23 @@
+= Jan 2016
+
+🐞 Bug Fixes
+
+- Wicket Viewer CSV upload issue
https://issues.apache.org/jira/browse/CAUSEWAY-3950[CAUSEWAY-3950]
+- Wicket Viewer CSV download issue
https://issues.apache.org/jira/browse/CAUSEWAY-3958[CAUSEWAY-3958]
+
+⭐ New Features
+
+- (re-)enables CI test jobs for v2 commits and pull requests
+- cleaning up POMs, e.g. removes release related profiles
+
+📔 Documentation
+
+- `README` (v2) to include build instructions and changelog
+
+🔨 Dependency Upgrades
+
+- Upgrade `archunit` 1.3.0 -> 1.3.2 (allows v2 build using JDK 25)
+
+= Up till Dec 2015
+
+- TODO
diff --git a/adoc/ci-instructions.adoc b/adoc/ci-instructions.adoc
new file mode 100644
index 00000000000..6af0be0b5df
--- /dev/null
+++ b/adoc/ci-instructions.adoc
@@ -0,0 +1,23 @@
+One can setup a gitlab repository just for the purpose of
+building and deploying _Causeway_ artifacts.
+
+A minimal build script could look like:
+
+[source,yaml]
+..gitlab-ci.yml
+----
+image: maven:3.9.12-eclipse-temurin-25
+
+include:
+ - local: ci/causeway-v2.yml
+ - local: ci/isis-v2.yml
+
+stages:
+ - checkout-patch-deploy
+----
+
+where the actual jobs are declared in their own files in the `ci` directory:
+
+TODO flesh out `ci/causeway-v2.yml`
+
+TODO flesh out `ci/isis-v2.yml`
\ No newline at end of file
