From 0a81cb1680d54c342094fdb011e9c4d92d64c1df Mon Sep 17 00:00:00 2001 From: Pablo Aguilar Date: Tue, 19 Mar 2024 00:46:57 -0300 Subject: [PATCH] docs: update documentation Signed-off-by: Pablo Aguilar --- docs/user-guide/tracking_strategies.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/user-guide/tracking_strategies.md b/docs/user-guide/tracking_strategies.md index 57dfc5f907b65d..2483d14ac9d336 100644 --- a/docs/user-guide/tracking_strategies.md +++ b/docs/user-guide/tracking_strategies.md @@ -25,14 +25,15 @@ Helm chart versions are [Semantic Versions](https://semver.org/). As a result, y ## Git -For Git, all versions are Git references: +For Git, all versions are Git references but tags [Semantic Versions](https://semver.org/) can also be used: | Use Case | How | Notes | |-|-|-| | Pin to a version (e.g. in production) | Either (a) tag the commit with (e.g. `v1.2.0`) and use that tag, or (b) using commit SHA. | See [commit pinning](#commit-pinning). | -| Track patches (e.g. in pre-production) | Tag/re-tag the commit, e.g. (e.g. `v1.2`) and use that tag. | See [tag tracking](#tag-tracking) | -| Track minor releases (e.g. in QA) | Re-tag the commit as (e.g. `v1`) and use that tag. | See [tag tracking](#tag-tracking) | -| Use the latest (e.g. in local development) | Use `HEAD` or `master` (assuming `master` is your master branch). | See [HEAD / Branch Tracking](#head-branch-tracking) | +| Track patches (e.g. in pre-production) | Use a range (e.g. `1.2.*` or `>=1.2.0 <1.3.0`) | See [tag tracking](#tag-tracking) | +| Track minor releases (e.g. in QA) | Use a range (e.g. `1.*` or `>=1.0.0 <2.0.0`) | See [tag tracking](#tag-tracking) | +| Use the latest (e.g. in local development) | Use `HEAD` or `master` (assuming `master` is your master branch). | See [HEAD / Branch Tracking](#head-branch-tracking) | +| Use the latest including pre-releases | Use star range with `-0` suffix | `*-0` or `>=0.0.0-0` | ### HEAD / Branch Tracking @@ -53,6 +54,9 @@ To redeploy an app, the user uses Git to change the meaning of a tag by retaggin different commit SHA. Argo CD will detect the new meaning of the tag when performing the comparison/sync. +But if you're using semantic versioning you can set the constraint in your service revision +and Argo CD will always get the latest version following the constraint rules. + ### Commit Pinning If a Git commit SHA is specified, the app is effectively pinned to the manifests defined at