Skip to content

Commit 6406fb9

Browse files
authored
Add Warning not to track sensitive data (#43)
1 parent 0d0b540 commit 6406fb9

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ All notable changes to this project will be documented in this file.
44
This project adheres to [Semantic Versioning](http://semver.org/).
55
The format is based on [Keep a Changelog](http://keepachangelog.com/).
66

7-
## Version 1.0.3 - 07.11.23
7+
## Version 1.0.3 - 10.11.23
88

99
### Added
1010

1111
- Added note about using `SAPUI5 v1.120.0` or later for proper lazy loading of the *Change History* table.
12+
- In README, add warning about tracking personal data.
1213

1314
### Changed
1415

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,9 @@ npm add @cap-js/change-tracking
6969

7070
## Annotations
7171

72+
> [!WARNING]
73+
> 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).
74+
7275
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_:
7376

7477
```cds

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@cap-js/change-tracking",
3-
"version": "1.0.2",
3+
"version": "1.0.3",
44
"description": "CDS plugin providing out-of-the box support for automatic capturing, storing, and viewing of the change records of modeled entities.",
55
"repository": "cap-js/change-tracking",
66
"author": "SAP SE (https://www.sap.com)",

0 commit comments

Comments
 (0)