Skip to content

Commit

Permalink
Reword <protocol> to explicitly say git[+<subprotocol>]
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
dominykas committed Dec 13, 2023
1 parent 888817f commit 0f6cd2f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions hips/hip-00NN.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ The `Chart.yaml` should support the following format for `dependencies`:
```
dependencies:
- name: "<dependency name>"
repository: "<protocol>://<hostname>[:<port>][:][/]<path>"
repository: "git[+<subprotocol>]://<hostname>[:<port>][:][/]<path>"
version: "<commit-ish>"
```
where:
- `<protocol>` is one of `git`, `git+ssh`, `git+http`, `git+https`, or `git+file`.
- `<subprotocol>` is a protocol supported by `git clone` (e.g. `ssh`, `http`, `https`, `file`, etc).
- `<commit-ish>` is an existing reference (SHA hash, tag or branch name) on the repo.

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

## Reference implementation

Expand Down

0 comments on commit 0f6cd2f

Please sign in to comment.