Add Warning not to track sensitive data (#43)

cap-js · Nov 10, 2023 · 6406fb9 · 6406fb9
1 parent 0d0b540
commit 6406fb9
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,11 +4,12 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
-## Version 1.0.3 - 07.11.23
+## Version 1.0.3 - 10.11.23
 
 ### Added
 
 - Added note about using `SAPUI5 v1.120.0` or later for proper lazy loading of the *Change History* table.
+- In README, add warning about tracking personal data.
 
 ### Changed
 

diff --git a/README.md b/README.md
@@ -69,6 +69,9 @@ npm add @cap-js/change-tracking
 
 ## Annotations
 
+> [!WARNING]
+> Please be aware that [**sensitive** or **personal** data](https://cap.cloud.sap/docs/guides/data-privacy/annotations#annotating-personal-data) should not be change tracked, since viewing the log allows users to circumvent [audit-logging](https://cap.cloud.sap/docs/guides/data-privacy/audit-logging#setup).
+
 All we need to do is to identify what should be change-tracked by annotating respective entities and elements in our model with the `@changelog` annotation. Following the [best practice of separation of concerns](https://cap.cloud.sap/docs/guides/domain-modeling#separation-of-concerns), we do so in a separate file _srv/change-tracking.cds_:
 
 ```cds

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/change-tracking",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "CDS plugin providing out-of-the box support for automatic capturing, storing, and viewing of the change records of modeled entities.",
   "repository": "cap-js/change-tracking",
   "author": "SAP SE (https://www.sap.com)",