Skip to content

Commit

Permalink
Document compatible release requirements
Browse files Browse the repository at this point in the history
Closes: #9782
  • Loading branch information
srittau authored and radoering committed Oct 21, 2024
1 parent 3e5e038 commit 81b7e3b
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/dependency-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}}
Expand Down

0 comments on commit 81b7e3b

Please sign in to comment.