|
1 |
| -# helm schema gen plugin [ CURRENTLY NOT MAINTAINED ] |
| 1 | +# helm schema gen plugin |
2 | 2 |
|
3 |
| - |
| 3 | + |
4 | 4 |
|
5 | 5 | So that you don't have to write values.schema.json by hand from scratch for your Helm 3 charts
|
6 | 6 |
|
7 | 7 | [Helm](https://helm.sh) plugin to generate [JSON Schema for values yaml](https://helm.sh/docs/topics/charts/#schema-files)
|
8 | 8 |
|
9 |
| -## Note about maintenance |
10 |
| - |
11 |
| -I currently don't have the bandwidth to reply to issues, write code and review PRs. For now I recommend forking the repo and making changes and using the fork 😅 |
12 |
| - |
13 | 9 | ## Code stuff
|
14 | 10 |
|
15 | 11 | Nothing fancy about the code, all the heavy lifting is done by:
|
16 | 12 |
|
17 |
| -- [go-jsonschema-generator](https://github.com/karuppiah7890/go-jsonschema-generator) - for generating JSON schema. It's a fork of [this](https://github.com/mcuadros/go-jsonschema-generator). Thanks to [@mcuadros](https://github.com/mcuadros) |
| 13 | +- [go-jsonschema-generator](https://github.com/KnechtionsCoding/go-jsonschema-generator) - for generating JSON schema. It's a fork of [this](https://github.com/mcuadros/go-jsonschema-generator). Thanks to [@mcuadros](https://github.com/mcuadros) |
18 | 14 | - [go-yaml](https://github.com/go-yaml/yaml/) - for YAML parsing
|
19 | 15 | - [cobra](https://github.com/spf13/cobra) - for CLI stuff
|
20 | 16 | - [The Go stdlib](https://golang.org/pkg/) - for everything else
|
21 | 17 |
|
22 |
| - |
23 | 18 | ## Install
|
24 | 19 |
|
25 | 20 | The plugin works with both Helm v2 and v3 versions as it's agnostic to the Helm
|
26 | 21 | binary version
|
27 | 22 |
|
28 | 23 | ```
|
29 |
| -$ helm plugin install https://github.com/karuppiah7890/helm-schema-gen.git |
30 |
| -karuppiah7890/helm-schema-gen info checking GitHub for tag '0.0.4' |
31 |
| -karuppiah7890/helm-schema-gen info found version: 0.0.4 for 0.0.4/Darwin/x86_64 |
32 |
| -karuppiah7890/helm-schema-gen info installed ./bin/helm-schema-gen |
| 24 | +$ helm plugin install https://github.com/KnechtionsCoding/helm-schema-gen.git |
| 25 | +KnechtionsCoding/helm-schema-gen info checking GitHub for tag '0.0.4' |
| 26 | +KnechtionsCoding/helm-schema-gen info found version: 0.0.4 for 0.0.4/Darwin/x86_64 |
| 27 | +KnechtionsCoding/helm-schema-gen info installed ./bin/helm-schema-gen |
33 | 28 | Installed plugin: schema-gen
|
34 | 29 | ```
|
35 | 30 |
|
@@ -217,14 +212,9 @@ $ helm schema-gen values.yaml
|
217 | 212 | You can save it to a file like this
|
218 | 213 |
|
219 | 214 | ```
|
220 |
| -$ helm schema-gen values.yaml > values.schema.json |
| 215 | +helm schema-gen values.yaml > values.schema.json |
221 | 216 | ```
|
222 | 217 |
|
223 | 218 | ## Issues? Feature Requests? Proposals? Feedback?
|
224 | 219 |
|
225 |
| -Note: I currently don't have the bandwidth to reply to issues, write code and review PRs. For now I recommend forking the repo and making changes and using the fork 😅 |
226 |
| - |
227 |
| -Put them all in [GitHub issues](https://github.com/karuppiah7890/helm-schema-gen/issues) 😁 |
228 |
| -I value every feedback. I really want to make sure that my tools help people and does not |
229 |
| -annoy people. I want my tools to enable people and not hinder them. I'll do my best to help you |
230 |
| -if you face any hindrance because of using my tools! :) |
| 220 | +Put them all in [GitHub issues](https://github.com/KnechtionsCoding/helm-schema-gen/issues) |
0 commit comments