From dd110ae2f069e3d42d2d57f84140fc6308061f8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominykas=20Blyz=CC=8Ce=CC=87?= Date: Mon, 4 Dec 2023 14:15:00 +0200 Subject: [PATCH] docs: update docs to follow the latest version of the HIP MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/helm/community/pull/321 Signed-off-by: Dominykas Blyžė --- cmd/helm/dependency.go | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/cmd/helm/dependency.go b/cmd/helm/dependency.go index 76a8ed84687..0771edd5e9c 100644 --- a/cmd/helm/dependency.go +++ b/cmd/helm/dependency.go @@ -73,34 +73,32 @@ repository added to helm by "helm add repo". Version matching is also supported for this case. A repository can be defined as a git URL. The path must start with a prefix of -"git://" followed by a valid git repository URL. +"git+" followed by a valid git repository URL. # Chart.yaml dependencies: - name: helm-chart version: "main" - repository: "git://https://github.com/helm/helm-chart.git" + repository: "git+https://github.com/helm/helm-chart.git" The 'repository' can be the https or ssh URL that you would use to clone a git repo or add as a git remote, prefixed with 'git:'. -For example 'git://git@github.com:helm/helm-chart.git' or -'git://https://github.com/helm/helm-chart.git' +For example 'git+ssh://git@github.com:helm/helm-chart.git' or +'git+https://github.com/helm/helm-chart.git' -When using a 'git://' repository, the 'version' must be a valid semantic tag or branch -name for the git repo. For example 'master'. +When using a 'git://' repository, the 'version' must be a valid semantic tag +or branch name for the git repo, for example 'main'. Limitations when working with git repositories: * Helm will use the 'git' executable on your system to retrieve information about the repo. The 'git' command must be properly configured and available on the PATH. * When specifying a private repo, if git tries to query the user for -username/passowrd for an HTTPS url, or for a certificate password for an SSH -url, it may cause Helm to hang. Input is not forwarded to the child git -process, so it will not be able to receive user input. For private repos -it is recommended to use an SSH git url, and have your git client configured -with an SSH cert that does not require a password. -* The helm chart and 'Chart.yaml' must be in the root of the git repo. -The chart cannot be loaded from a subdirectory. +username/password for an HTTPS URL, or for a certificate password for an SSH +URL, it may cause Helm to hang. Input is not forwarded to the child git +process, so it will not be able to receive user input. Authentication can be +configured by using a git credentials helper which can read the credentials +from environment variables, from operating system keychain, etc. ` const dependencyListDesc = `