Skip to content

Commit 39f9df2

Browse files
committed
docs: update docs to follow the latest version of the HIP
See helm/community#321 Signed-off-by: Dominykas Blyžė <[email protected]>
1 parent 3ba8354 commit 39f9df2

File tree

2 files changed

+12
-14
lines changed

2 files changed

+12
-14
lines changed

cmd/helm/dependency.go

+11-13
Original file line numberDiff line numberDiff line change
@@ -73,34 +73,32 @@ repository added to helm by "helm add repo". Version matching is also supported
7373
for this case.
7474
7575
A repository can be defined as a git URL. The path must start with a prefix of
76-
"git://" followed by a valid git repository URL.
76+
"git+" followed by a valid git repository URL.
7777
7878
# Chart.yaml
7979
dependencies:
8080
- name: helm-chart
8181
version: "main"
82-
repository: "git://https://github.com/helm/helm-chart.git"
82+
repository: "git+https://github.com/helm/helm-chart.git"
8383
8484
The 'repository' can be the https or ssh URL that you would use to clone a git
8585
repo or add as a git remote, prefixed with 'git:'.
86-
For example 'git://git@github.com:helm/helm-chart.git' or
87-
'git://https://github.com/helm/helm-chart.git'
86+
For example 'git+ssh://github.com:helm/helm-chart.git' or
87+
'git+https://github.com/helm/helm-chart.git'
8888
89-
When using a 'git://' repository, the 'version' must be a valid semantic tag or branch
90-
name for the git repo. For example 'master'.
89+
When using a 'git[+subprotocol]>://' repository, the 'version' must be a valid
90+
tag or branch name for the git repo, for example 'main'.
9191
9292
Limitations when working with git repositories:
9393
* Helm will use the 'git' executable on your system to retrieve information
9494
about the repo. The 'git' command must be properly configured and available
9595
on the PATH.
9696
* When specifying a private repo, if git tries to query the user for
97-
username/passowrd for an HTTPS url, or for a certificate password for an SSH
98-
url, it may cause Helm to hang. Input is not forwarded to the child git
99-
process, so it will not be able to receive user input. For private repos
100-
it is recommended to use an SSH git url, and have your git client configured
101-
with an SSH cert that does not require a password.
102-
* The helm chart and 'Chart.yaml' must be in the root of the git repo.
103-
The chart cannot be loaded from a subdirectory.
97+
username/password for an HTTPS URL, or for a certificate password for an SSH
98+
URL, it may cause Helm to hang. Input is not forwarded to the child git
99+
process, so it will not be able to receive user input. Authentication can be
100+
configured by using a git credentials helper which can read the credentials
101+
from environment variables, from operating system keychain, etc.
104102
`
105103

106104
const dependencyListDesc = `

internal/resolver/resolver.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ func (r *Resolver) Resolve(reqs []*chart.Dependency, repoNames map[string]string
120120

121121
if !found {
122122
return nil, fmt.Errorf(`dependency %q is missing git branch or tag: %s.
123-
When using a "git://" type repository, the "version" should be a valid branch or tag name`, d.Name, d.Version)
123+
When using a "git[+subprotocol]://" type repository, the "version" should be a valid branch or tag name`, d.Name, d.Version)
124124
}
125125

126126
locked[i] = &chart.Dependency{

0 commit comments

Comments
 (0)