Skip to content

Commit

Permalink
update readme about maintenance
Browse files Browse the repository at this point in the history
  • Loading branch information
karuppiah7890 authored Jul 8, 2021
1 parent 97b00c6 commit 07a094a
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,20 @@ So that you don't have to write values.schema.json by hand from scratch for your

[Helm](https://helm.sh) plugin to generate [JSON Schema for values yaml](https://helm.sh/docs/topics/charts/#schema-files)

## Note about maintenance

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 😅

## Code stuff

Nothing fancy about the code, all the heavy lifting is done by:

- [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)
- [go-yaml](https://github.com/go-yaml/yaml/) - for YAML parsing
- [cobra](https://github.com/spf13/cobra) - for CLI stuff
- [The Go stdlib](https://golang.org/pkg/) - for everything else


## Install

The plugin works with both Helm v2 and v3 versions as it's agnostic to the Helm
Expand Down Expand Up @@ -215,6 +222,8 @@ $ helm schema-gen values.yaml > values.schema.json

## Issues? Feature Requests? Proposals? Feedback?

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 😅

Put them all in [GitHub issues](https://github.com/karuppiah7890/helm-schema-gen/issues) 😁
I value every feedback. I really want to make sure that my tools help people and does not
annoy people. I want my tools to enable people and not hinder them. I'll do my best to help you
Expand Down

0 comments on commit 07a094a

Please sign in to comment.