{"id":29785855,"url":"https://github.com/cozystack/readme-generator-for-helm","last_synced_at":"2025-07-27T17:35:49.166Z","repository":{"id":305038454,"uuid":"1021715017","full_name":"cozystack/readme-generator-for-helm","owner":"cozystack","description":"Auto generate READMEs for Helm Charts","archived":false,"fork":false,"pushed_at":"2025-07-17T21:19:06.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-18T00:20:41.079Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cozystack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-17T20:40:23.000Z","updated_at":"2025-07-17T21:18:50.000Z","dependencies_parsed_at":"2025-07-18T02:36:22.972Z","dependency_job_id":"71d4dde5-5194-4e36-8a38-1caa432cb03f","html_url":"https://github.com/cozystack/readme-generator-for-helm","commit_stats":null,"previous_names":["cozystack/readme-generator-for-helm"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/cozystack/readme-generator-for-helm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cozystack%2Freadme-generator-for-helm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cozystack%2Freadme-generator-for-helm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cozystack%2Freadme-generator-for-helm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cozystack%2Freadme-generator-for-helm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cozystack","download_url":"https://codeload.github.com/cozystack/readme-generator-for-helm/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cozystack%2Freadme-generator-for-helm/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267394658,"owners_count":24080364,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-27T02:00:11.917Z","response_time":82,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-27T17:35:44.853Z","updated_at":"2025-07-27T17:35:49.160Z","avatar_url":"https://github.com/cozystack.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Readme Generator for Helm (Go)\n\n\u003e **Go port of [`bitnami/readme-generator-for-helm`](https://github.com/bitnami/readme-generator-for-helm)**\n\u003e\n\u003e Drop‑in replacement that keeps the same CLI **and metadata syntax**, but ships as a single statically‑linked Go binary.\n\n---\n\n* Autogenerates a **Parameters** table in your chart’s `README.md` from the metadata found in `values.yaml`.\n* Optionally emits an **OpenAPI v3** JSON schema that describes the structure of `values.yaml`.\n\nBoth features behave *exactly* like the original Bitnami tool, so you can switch by merely replacing the binary in your pipeline.\n\n---\n\n## How it works\n\nThe generator looks for Javadoc‑style comments inside `values.yaml`. It validates that every real key has corresponding metadata (and vice‑versa); if everything lines up it rewrites the `## Parameters` section of `README.md` and/or writes an OpenAPI schema file.  If mismatches are detected it prints a detailed error list and exits with a non‑zero status, making it CI‑friendly.\n\nThe table it injects has the familiar structure\n\n```markdown\n## Parameters\n\n### Section 1 title\n\n| Name      | Description             | Default        |\n|:----------|:------------------------|:---------------|\n| `value_1` | Description for value 1 | `defaultValue` |\n| `value_2` | Description for value 2 | `defaultValue` |\n\n### Section 2 title\n\n| Name      | Description             | Default        |\n|:----------|:------------------------|:---------------|\n| `value_a` | Description for value a | `defaultValue` |\n```\n\nThe top‑level heading (`## Parameters`, `### Parameters`, …) is detected dynamically; its text can be customised via the [configuration file](#configuration-file).\n\n---\n\n## Requirements\n\n* Go **1.22+** (any platform supported by Go)\n\n---\n\n## Installation\n\n### Using `go install` (recommended)\n\n```console\ngo install github.com/cozystack/readme-generator-for-helm@latest\n```\n\nThe binary lands in `$(go env GOPATH)/bin` (usually `~/go/bin`). Make sure that directory is on your `$PATH`.\n\n### Download a pre‑built release binary\n\nHead over to [https://github.com/cozystack/readme-generator-for-helm/releases](https://github.com/cozystack/readme-generator-for-helm/releases), grab the archive for your OS/arch, unpack it somewhere on your `$PATH`.\n\n### Build from source\n\n```console\ngit clone https://github.com/cozystack/readme-generator-for-helm\ncd readme-generator-for-helm\ngo build -o readme-generator-for-helm\n```\n\n---\n\n## Basic usage\n\n```console\nreadme-generator-for-helm [options]\n\nOptions:\n  -v, --values  \u003cfile\u003e   Path to the values.yaml file (required)\n  -r, --readme  \u003cfile\u003e   Path to the README.md file to update\n  -c, --config  \u003cfile\u003e   Path to config.json (optional; built‑in defaults if omitted)\n  -s, --schema  \u003cfile\u003e   Path for the generated OpenAPI Schema\n      --version          Print program version and exit\n  -h, --help             Show help\n```\n\n*At least one of* `--readme` *or* `--schema` *must be provided.*\n\n---\n\n## `values.yaml` metadata\n\nThe comment syntax, tags and modifiers are preserved from the original project:\n\n* **Parameter:**     `## @param full.key.path [modifier1,modifier2] Description`\n* **Section:**       `## @section Section Title`\n* **Skip subtree:**  `## @skip full.key.path`\n* **Intermediate object description:** `## @extra full.key.path Description`\n\nSupported modifiers (customisable via the config file):\n\n| Modifier        | Effect                                       |\n| --------------- | -------------------------------------------- |\n| `array`         | Treat parameter as array, default `[]`       |\n| `object`        | Treat parameter as object, default `{}`      |\n| `string`        | Force empty string default `\"\"`              |\n| `nullable`      | Parameter may be `null`; default stays as‑is |\n| `default:VALUE` | Override default with given literal `VALUE`  |\n\n\u003e **Important:** Ordering of tags in the YAML file does not matter, *except* for `@section`, which groups all subsequent `@param`s until the next `@section`.\n\n---\n\n## Configuration file\n\nIf you need to change comment delimiters, tag names, or add custom modifiers, provide a JSON file via `--config`:\n\n```json\n{\n  \"comments\": { \"format\": \"##\" },\n  \"tags\": {\n    \"param\": \"@param\",\n    \"section\": \"@section\",\n    \"descriptionStart\": \"@descriptionStart\",\n    \"descriptionEnd\": \"@descriptionEnd\",\n    \"skip\": \"@skip\",\n    \"extra\": \"@extra\"\n  },\n  \"modifiers\": {\n    \"array\": \"array\",\n    \"object\": \"object\",\n    \"string\": \"string\",\n    \"nullable\": \"nullable\",\n    \"default\": \"default\"\n  },\n  \"regexp\": { \"paramsSectionTitle\": \"Parameters\" }\n}\n```\n\nOmit the flag entirely to use the built‑in defaults (same as above).\n\n---\n\n## License\n\nApache License 2.0 © 2025 Cozystack.\nPortions of the code are adapted from the original Bitnami implementation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcozystack%2Freadme-generator-for-helm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcozystack%2Freadme-generator-for-helm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcozystack%2Freadme-generator-for-helm/lists"}