From 099c866cfc15a8029633e19630713178beb28c9f Mon Sep 17 00:00:00 2001
From: Timm Fitschen <t.fitschen@indiscale.com>
Date: Thu, 3 Sep 2020 11:27:54 +0200
Subject: [PATCH] DOC: update CHANGELOG, README_SETUP
---
CHANGELOG.md | 7 ++++++-
README_SETUP.md | 18 ++++++++++++++++++
2 files changed, 24 insertions(+), 1 deletion(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index abd00462..fccd7c8f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -19,7 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Security
-## v0.2 (2020-09-02)
+## [0.2] - 2020-09-02
### Added
@@ -45,6 +45,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
+* All caosdb server java classes moved from `caosdb.[...]` to
+ `org.caosdb.[...]` because the new root package is compliant with the java
+ package naming conventions while the old was not. This has some implications
+ for configuring the server. See [README_SETUP.md](./README_SETUP.md), section
+ "Migration" for additional information.
- The sever by default now only serves TLS 1.2 and 1.3, all previous versions
have been disabled in the default settings. Make sure that your clients
(especially the Python client) are up to date.
diff --git a/README_SETUP.md b/README_SETUP.md
index c1e0f333..97b5282c 100644
--- a/README_SETUP.md
+++ b/README_SETUP.md
@@ -149,3 +149,21 @@ certificate.
Build Project`.
Done!
+
+# Migration
+
+## From 0.1 to 0.2
+
+A major change in the code is the renaming of the java packages (from
+`caosdb.[...]` to `org.caosdb.[...]`).
+
+This makes its necessary to change some of your config files as well. Whenever
+you configured a class (e.g. the `EMAIL_HANDLER`, or the realms in your
+`usersources.ini`) you would need to reconfigure it there.
+
+The following `sed` command could be useful. However, use it with care and backup
+before you execute it.
+
+```sh
+sed -i.bak -e "s/\(\s*\)\([^.]\)caosdb\.server/\1\2org.caosdb.server/g" FILE_TO_BE_CHANGED
+```
--
GitLab