From a3af75f9b607ee6f96b1c61f09e5c13f29a06538 Mon Sep 17 00:00:00 2001 From: Tim H Date: Tue, 5 Dec 2017 13:25:56 +0100 Subject: [PATCH] Fix example and reference version matching syntax Address documentation issue raised in #2759 --- docs/chart_best_practices/requirements.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/chart_best_practices/requirements.md b/docs/chart_best_practices/requirements.md index 0bbdfdfd7..ca63f3425 100644 --- a/docs/chart_best_practices/requirements.md +++ b/docs/chart_best_practices/requirements.md @@ -7,10 +7,12 @@ This section of the guide covers best practices for `requirements.yaml` files. Where possible, use version ranges instead of pinning to an exact version. The suggested default is to use a patch-level version match: ```yaml -version: ^1.2.0 +version: ~1.2.3 ``` -This will match version 1.2.0 and any patches to that release (1.2.1, 1.2.999, and so on) +This will match version `1.2.3` and any patches to that release. In other words, `~1.2.3` is equivalent to `>= 1.2.3, < 1.3.0` + +For the complete version matching syntax, please see the [semver documentation](https://github.com/Masterminds/semver#checking-version-constraints) ### Repository URLs @@ -42,4 +44,4 @@ tags: - webaccelerator ``` -This allows a user to turn that feature on and off with one tag. \ No newline at end of file +This allows a user to turn that feature on and off with one tag.