Skip to content

Commit 8d3862f

Browse files
updated docs
1 parent 76ff48b commit 8d3862f

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,16 +85,36 @@ assumptions were made that are potentially invalid in other scenarios.
8585
It merely is a playground for developers wanting to kick the tires in the EDC and DCP space, and its purpose is to
8686
demonstrate how DCP works to an otherwise unassuming audience.
8787

88-
### 2.1 Which version should I use?
88+
### 2.1 Version stability and backwards compatibility guarantees
89+
90+
It is important to understand that while we _do_ tag the git tree at certain times, the intention there is to provide
91+
stable builds for adopters and to avoid randomly breaking builds. MVD releases simply use _release_ versions of upstream
92+
components, as opposed to the `main` branch, which uses `-SNAPSHOT` versions. The latter case can occasionally lead to
93+
breaking builds.
94+
95+
However, all of our development work in MVD targets the `main` branch. In other words, we do not backport bugfixes to
96+
older releases of MVD. If there is a bug or a new feature either in one of the upstream components or MVD, fixes will
97+
_always_ target `main` and will surface in one of the upcoming MVD releases.
98+
99+
This is yet another reason why MVD should _never_ be used in production scenarios!
100+
101+
Please also note that MVD does not publish any artifacts (Maven, Docker images, ...), adopters have to build from
102+
source.
103+
104+
TL;DR - there are none. This is a _sample_ project, not a commercial product.
105+
106+
### 2.2 Which version should I use?
89107

90108
The repo's default branch is `main`, which serves as development branch and is checked out by default. If you don't do
91-
anything, then you'll get the absolute latest version of MVD. This is suitable for everyone who is okay with pulling
109+
anything, then you'll get the absolute latest version of MVD. This is suitable for anyone who is okay with pulling
92110
frequently and with the occasional breakage. The upshot is that this branch will always contain the latest features and
93111
fixes of all upstream components.
94112

113+
> We have monitoring systems im place that inform us about broken builds. No need to raise issues about this.
114+
95115
More conservative developers may fall back
96116
to [releases of MVD](https://github.com/eclipse-edc/MinimumViableDataspace/releases) that use release versions of all
97-
upstream components.
117+
upstream components. If this is you, then don't forget to check out the appropriate tag after cloning the repo.
98118

99119
Either download the ZIP file and use sources therein, or check out the corresponding tag.
100120

0 commit comments

Comments
 (0)