/
README.gotmpl
43 lines (27 loc) · 1.37 KB
/
README.gotmpl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# Charts
[](https://github.com/ccremer/charts/blob/master/LICENSE)
[](https://github.com/ccremer/charts/releases)
[ccremer](https://github.com/ccremer)'s Helm charts repository
## List of Charts
| Downloads & Changelog | Chart |
| --- | --- |
{{- range .charts }}
| {{ if .version }}[](https://github.com/ccremer/charts/releases/tag/{{ .name }}-{{ .version }}){{ end }} | [{{ .name }}]({{ .dir }}{{ .name }}/README.md) |
{{- end -}}
{{ if .masterBranch }}
## Development
### Requirements
* `helm`
* `docker`
### Testing
Scaffold chart unit tests by copying existing unit tests and place it into a `test` dir within your chart dir.
Develop your Go unit tests and make sure they run successfully.
To run all test, run `make test`.
### Documentation
This chart repository generates READMEs from [Helm-Docs](https://github.com/norwoodj/helm-docs/).
That means you have to format your `values.yaml` in a certain way.
See link or existing charts for examples.
The root README is also generated so that it links to the new chart.
You can generate the chart README.md with `make docs:helm`.
To generate all documentations, run `make docs`.
{{- end }}