{"repo":"bitnami/readme-generator-for-helm","free":true,"listed":false,"github":"https://github.com/bitnami/readme-generator-for-helm","clone":"git clone https://github.com/bitnami/readme-generator-for-helm.git","description":"Auto generate READMEs for Helm Charts","language":"JavaScript","stars":311,"topics":["charts","helm","readme","readme-generator"],"license":"Apache-2.0","category":"deployment-docker-iac","readme_excerpt":"Readme Generator For Helm - Autogenerate Helm Charts READMEs' tables based on values YAML file metadata. - Autogenerate an OpenAPI compliant JSON schema defining the values.yaml structure of the Helm Chart. The file generated will be a JSON file formatted according to the OpenAPIv3 SchemaObject definition. How it works The tool expects some metadata for the descriptions in the provided values.yaml file. It will parse and check the metadata against the real values. If the metadata is consistent with the real values, it will generate and insert the values table into the provided README.md file. If the metadata is not correct, it will print the full list of errors. It checks whether there is metadata for non-existing values or there is missing metadata for an existing value. The table that will be inserted into the readme.md will have the following structure: The number of # characters needed for the section titles is dynamically calculated, and the title of the Parameters section can be configured via the configuration file. The README.md file with a ## Parameters section must be created before running the tool, the Parameters section should have two # or more symbols. Requirements The project has been developed and tested with node version 22.x . Install Execute the following commands to install the tool: Depending on how you installed NodeJS in your system, you may need to modify your PATH environment variable to be able to execute the tool. NOTE: Starting with version 2.8.0 ","default_branch":null,"files":null,"tree":[],"storefront":"/r/bitnami","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/bitnami/readme-generator-for-helm/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}