Skip to content

Commit

Permalink
docs: update docs to follow the latest version of the HIP
Browse files Browse the repository at this point in the history
See helm/community#321

Signed-off-by: Dominykas Blyžė <hello@dominykas.com>
  • Loading branch information
dominykas committed Feb 6, 2024
1 parent 3ba8354 commit 39f9df2
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 14 deletions.
24 changes: 11 additions & 13 deletions cmd/helm/dependency.go
Original file line number Diff line number Diff line change
Expand Up @@ -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://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[+subprotocol]>://' repository, the 'version' must be a valid
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 = `
Expand Down
2 changes: 1 addition & 1 deletion internal/resolver/resolver.go
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ func (r *Resolver) Resolve(reqs []*chart.Dependency, repoNames map[string]string

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

locked[i] = &chart.Dependency{
Expand Down

0 comments on commit 39f9df2

Please sign in to comment.