From c943b3ef2755a136bd2fb2b2cadb1ad939f1539b Mon Sep 17 00:00:00 2001 From: Mark Sagi-Kazar Date: Wed, 22 Sep 2021 23:10:51 +0200 Subject: [PATCH] docs: propose dropping file writing support Signed-off-by: Mark Sagi-Kazar --- ...efer-making-backward-compatible-changes.md | 2 ++ docs/adr/0007-drop-writing-support.md | 22 +++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 docs/adr/0007-drop-writing-support.md diff --git a/docs/adr/0002-prefer-making-backward-compatible-changes.md b/docs/adr/0002-prefer-making-backward-compatible-changes.md index fc1e4e3..4651d28 100644 --- a/docs/adr/0002-prefer-making-backward-compatible-changes.md +++ b/docs/adr/0002-prefer-making-backward-compatible-changes.md @@ -10,6 +10,8 @@ Referenced by [3. Extract components with heavy dependencies from the core](0003 Referenced by [4. Use separate GitHub organization for new packages](0004-use-separate-github-organization-for-new-packages.md) +Referenced by [7. Drop writing support](0007-drop-writing-support.md) + ## Context Architecturally speaking Viper became a giant over the years: it hides a lot of complexity behind a simple interface. diff --git a/docs/adr/0007-drop-writing-support.md b/docs/adr/0007-drop-writing-support.md new file mode 100644 index 0000000..c740dc1 --- /dev/null +++ b/docs/adr/0007-drop-writing-support.md @@ -0,0 +1,22 @@ +# 7. Drop writing support + +Date: 2021-09-22 + +## Status + +Proposed + +References [2. Prefer making backward compatible changes](0002-prefer-making-backward-compatible-changes.md) + +## Context + +The number one source of issues for Viper comes from the fact that it supports both reading and writing. +It causes concurrency issues and has lots of inconsistencies. + +## Decision + +Drop file writing support from Viper in v2. + +## Consequences + +This is going to be a major breaking change in the library, but it will make maintenance significantly easier.