Skip to content

Commit 0f6cd2f

Browse files
committed
Reword <protocol> to explicitly say git[+<subprotocol>]
As the protocols are handled by git, it's probably better to define them as something that's supported by `git clone`. Signed-off-by: Dominykas Blyžė <[email protected]>
1 parent 888817f commit 0f6cd2f

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

hips/hip-00NN.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ The `Chart.yaml` should support the following format for `dependencies`:
3737
```
3838
dependencies:
3939
- name: "<dependency name>"
40-
repository: "<protocol>://<hostname>[:<port>][:][/]<path>"
40+
repository: "git[+<subprotocol>]://<hostname>[:<port>][:][/]<path>"
4141
version: "<commit-ish>"
4242
```
4343
where:
44-
- `<protocol>` is one of `git`, `git+ssh`, `git+http`, `git+https`, or `git+file`.
44+
- `<subprotocol>` is a protocol supported by `git clone` (e.g. `ssh`, `http`, `https`, `file`, etc).
4545
- `<commit-ish>` is an existing reference (SHA hash, tag or branch name) on the repo.
4646

4747
For example:
@@ -77,6 +77,7 @@ This is something that needs to be taken into account in security conscious envi
7777
- The documentation should note the security caveat listed above
7878
- The documentation should provide the recommendation to prefer registries to git, if possible
7979
- The documentation should note the implications of git being mutable with a recommendation of pinning to specific hashes
80+
- The documentation could list the examples for various git protocols, but mention that Helm supports whatever `git clone` supports
8081

8182
## Reference implementation
8283

0 commit comments

Comments
 (0)