From c030cb28e0edc655f6f3626f74800f8a77fd825c Mon Sep 17 00:00:00 2001 From: dudicoco <51051860+dudicoco@users.noreply.github.com> Date: Mon, 18 Oct 2021 11:49:23 +0300 Subject: [PATCH] docs: improve docs for helm aliases (#12109) Co-authored-by: Rhys Arkins <rhys@arkins.net> Co-authored-by: Michael Kriese <michael.kriese@visualon.de> --- docs/usage/configuration-options.md | 4 ++-- lib/manager/helm-requirements/readme.md | 2 +- lib/manager/helmfile/readme.md | 2 ++ lib/manager/helmv3/readme.md | 2 +- 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index f414adf6d7..0456b9eab4 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -87,9 +87,9 @@ This makes it suitable for augmenting a preset or base list without displacing t ## aliases The `aliases` object is used for configuring registry aliases. -Currently it is needed/supported for the `helm-requirements` manager only. +Currently it is needed/supported for the `helm-requirements`, `helmv3` and `helmfile` managers only. -`helm-requirements` includes this default alias: +The above managers include this default alias: ```json { diff --git a/lib/manager/helm-requirements/readme.md b/lib/manager/helm-requirements/readme.md index bfe38755c5..62b12debb3 100644 --- a/lib/manager/helm-requirements/readme.md +++ b/lib/manager/helm-requirements/readme.md @@ -1,5 +1,5 @@ Renovate supports updating Helm Chart references within `requirements.yaml` files. -If your Helm charts make use of Aliases then you will need to configure an `aliases` object in your config to tell Renovate where to look for them. +If your Helm charts make use of repository Aliases then you will need to configure an `aliases` object in your config to tell Renovate where to look for them. If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more. diff --git a/lib/manager/helmfile/readme.md b/lib/manager/helmfile/readme.md index 3dedb96283..62f58c0458 100644 --- a/lib/manager/helmfile/readme.md +++ b/lib/manager/helmfile/readme.md @@ -1,3 +1,5 @@ Checks `helmfile.yaml` files and extracts dependencies for the `helm` datasource. +If your Helm charts make use of repository Aliases then you will need to configure an `aliases` object in your config to tell Renovate where to look for them. + If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more. diff --git a/lib/manager/helmv3/readme.md b/lib/manager/helmv3/readme.md index c104f73092..2d706bb3f3 100644 --- a/lib/manager/helmv3/readme.md +++ b/lib/manager/helmv3/readme.md @@ -1,5 +1,5 @@ Renovate supports updating Helm Chart references within `requirements.yaml` (Helm v2) and `Chart.yaml` (Helm v3) files. -If your Helm charts make use of Aliases then you will need to configure an `aliases` object in your config to tell Renovate where to look for them. +If your Helm charts make use of repository Aliases then you will need to configure an `aliases` object in your config to tell Renovate where to look for them. If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more. -- GitLab