From cf08feba7f013eb88ec31e11c2ff91f7255ed145 Mon Sep 17 00:00:00 2001 From: Sebastian Rittau Date: Sat, 19 Oct 2024 17:53:53 +0200 Subject: [PATCH 1/3] Document compatible release requirements Closes: #9782 --- docs/dependency-specification.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/dependency-specification.md b/docs/dependency-specification.md index b52f03100ba..6e5e12c3fba 100644 --- a/docs/dependency-specification.md +++ b/docs/dependency-specification.md @@ -109,6 +109,20 @@ Here are some more examples of caret requirements and the versions that would be | ^0.0 | >=0.0.0 <0.1.0 | | ^0 | >=0.0.0 <1.0.0 | +### Compatible release requirements + +**Compatible release requirements** specify a minimal version with the ability to update to later versions of the same level. +For example, if you specify a major, minor, and patch version, only patch-level changes are allowed. +If you only specify a major, and minor version, then minor- and patch-level changes are allowed. + +`~=1.2.3` is an example of a tilde requirement. + +| Requirement | Versions allowed | +| ----------- | ---------------- | +| ~=1.2.3 | >=1.2.3 <1.3.0 | +| ~=1.2 | >=1.2.0 <2.0.0 | +| ~=1 | >=1.0.0 | + ### Tilde requirements {{% warning %}} From 692d19e33d655aa0cec84eae1d9e772b34cf07c5 Mon Sep 17 00:00:00 2001 From: Sebastian Rittau Date: Sat, 19 Oct 2024 21:03:00 +0200 Subject: [PATCH 2/3] Drop invalid example --- docs/dependency-specification.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/dependency-specification.md b/docs/dependency-specification.md index 6e5e12c3fba..bca7ee62ea0 100644 --- a/docs/dependency-specification.md +++ b/docs/dependency-specification.md @@ -121,7 +121,6 @@ If you only specify a major, and minor version, then minor- and patch-level chan | ----------- | ---------------- | | ~=1.2.3 | >=1.2.3 <1.3.0 | | ~=1.2 | >=1.2.0 <2.0.0 | -| ~=1 | >=1.0.0 | ### Tilde requirements From 22ee70fce538e4bd6e579ecd7e446d9cc095b2aa Mon Sep 17 00:00:00 2001 From: Sebastian Rittau Date: Mon, 21 Oct 2024 17:05:27 +0200 Subject: [PATCH 3/3] Fix copy & paste error MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Randy Döring <30527984+radoering@users.noreply.github.com> --- docs/dependency-specification.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dependency-specification.md b/docs/dependency-specification.md index bca7ee62ea0..adc4c000a66 100644 --- a/docs/dependency-specification.md +++ b/docs/dependency-specification.md @@ -115,7 +115,7 @@ Here are some more examples of caret requirements and the versions that would be For example, if you specify a major, minor, and patch version, only patch-level changes are allowed. If you only specify a major, and minor version, then minor- and patch-level changes are allowed. -`~=1.2.3` is an example of a tilde requirement. +`~=1.2.3` is an example of a compatible release requirement. | Requirement | Versions allowed | | ----------- | ---------------- |