{"id":41199950,"url":"https://github.com/ejhayes/auto-plugin-helm-chartmuseum","last_synced_at":"2026-01-22T20:41:12.865Z","repository":{"id":181090568,"uuid":"657802333","full_name":"ejhayes/auto-plugin-helm-chartmuseum","owner":"ejhayes","description":"Auto plugin for helm","archived":false,"fork":false,"pushed_at":"2024-01-30T15:03:34.000Z","size":659,"stargazers_count":0,"open_issues_count":11,"forks_count":2,"subscribers_count":1,"default_branch":"next","last_synced_at":"2025-10-09T19:57:15.317Z","etag":null,"topics":["auto-release","chartmuseum","helm","helm-deployment","helm-docs","publishing","release","releases"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/auto-plugin-helm-chartmuseum","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ejhayes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2023-06-23T22:23:21.000Z","updated_at":"2023-07-17T23:48:13.000Z","dependencies_parsed_at":"2023-11-01T22:26:17.464Z","dependency_job_id":null,"html_url":"https://github.com/ejhayes/auto-plugin-helm-chartmuseum","commit_stats":null,"previous_names":["ejhayes/auto-plugin-helm-chartmuseum"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/ejhayes/auto-plugin-helm-chartmuseum","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ejhayes%2Fauto-plugin-helm-chartmuseum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ejhayes%2Fauto-plugin-helm-chartmuseum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ejhayes%2Fauto-plugin-helm-chartmuseum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ejhayes%2Fauto-plugin-helm-chartmuseum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ejhayes","download_url":"https://codeload.github.com/ejhayes/auto-plugin-helm-chartmuseum/tar.gz/refs/heads/next","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ejhayes%2Fauto-plugin-helm-chartmuseum/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28670603,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-22T19:36:09.361Z","status":"ssl_error","status_checked_at":"2026-01-22T19:36:05.567Z","response_time":144,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["auto-release","chartmuseum","helm","helm-deployment","helm-docs","publishing","release","releases"],"created_at":"2026-01-22T20:41:12.770Z","updated_at":"2026-01-22T20:41:12.839Z","avatar_url":"https://github.com/ejhayes.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# auto-plugin-helm-chartmuseum\n\n[![npm version](https://badge.fury.io/js/auto-plugin-helm-chartmuseum.svg)](https://badge.fury.io/js/auto-plugin-helm-chartmuseum) [![Maintainability](https://api.codeclimate.com/v1/badges/0786ebf1133fdadab59d/maintainability)](https://codeclimate.com/github/ejhayes/auto-plugin-helm-chartmuseum/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/0786ebf1133fdadab59d/test_coverage)](https://codeclimate.com/github/ejhayes/auto-plugin-helm-chartmuseum/test_coverage) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fejhayes%2Fauto-plugin-helm-chartmuseum.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fejhayes%2Fauto-plugin-helm-chartmuseum?ref=badge_shield) \u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)\n\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\nAuto plugin for helm charts! This plugin can do the following:\n\n- Sets helm package version to auto version\n- Updates local dependencies to auto version (if version specified is `0.0.0-local` or the value specified in the `replaceVersionString` param)\n- Replaces `file://....` with `repository` value if `replaceFileWithRepository` is set to `true`\n- Updates documentation using `helm-docs` if `useHelmDocs` is set to `true`\n- Pushes packages to chartmuseum (using `cm-push` plugin) if `push` is set to `true`\n\n## quickstart\n\nThis plugin has the following dependencies:\n\n- [`helm`](https://github.com/helm/helm): required\n- [`helm-docs`](https://github.com/norwoodj/helm-docs): required if `HELM_PLUGIN_USE_HELM_DOCS` is set to `true`\n- [`cm-push`](https://github.com/chartmuseum/helm-push): required if `HELM_PLUGIN_ENABLE_PUSH` is set to `true`\n\nTo use in your projects, add this to you `.autorc` file under `plugins` section:\n\n```\n{\n  \"plugins\": [\n    [\"auto-plugin-helm\", {\n      \"enableCanary\": true,\n      \"enablePrelreases\": true,\n      \"recursive\": true,\n      \"useHelmDocs\": true,\n      \"enablePush\": true,\n      \"forcePush\": true,\n      \"repository\": \"@myRepoAlias\",\n      \"publishRepository\": \"myRepoAlias\"\n    }]\n  ]\n}\n```\n\n### github actions\n\nYou can use this with GitHub actions as follows:\n\n```yaml\n- name: Setup Helm\n  uses: azure/setup-helm@v3\n- name: Setup helm-docs\n  run: |\n    wget https://github.com/norwoodj/helm-docs/releases/download/v1.11.0/helm-docs_1.11.0_Linux_x86_64.deb\n    sudo dpkg -i helm-docs_1.11.0_Linux_x86_64.deb\n    rm helm-docs_1.11.0_Linux_x86_64.deb\n- name: Setup Helm Push Plugin\n  run: helm plugin install https://github.com/chartmuseum/helm-push\n- name: Add Chartmuseum repo\n  run: helm repo add local $CHARTMUSEUM_BASE_URL\n- env:\n    HELM_PLUGIN_ENABLE_CANARY: true\n    HELM_PLUGIN_PUSH: true\n    HELM_PLUGIN_REPOSITORY: '@local'\n    HELM_PLUGIN_PUBLISH_REPOSITORY: local\n    GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n  run: npx auto shipit\n```\n\n## configuration\n\n| setting                     | description                                                    | environment variable                       | default       |\n| --------------------------- | -------------------------------------------------------------- | ------------------------------------------ | ------------- |\n| `path`                      | Path to charts                                                 | `HELM_PLUGIN_PATH`                         | `.`           |\n| `recursive`                 | Search for all charts in `path`                                | `HELM_PLUGIN_RECURSIVE`                    | `false`       |\n| `forcePush`                 | Force push chart versions                                      | `HELM_PLUGIN_FORCE_PUSH`                   | `false`       |\n| `push`                      | Push charts to repository                                      | `HELM_PLUGIN_PUSH`                         | `false`       |\n| `enableCanary`              | Enable canary builds                                           | `HELM_PLUGIN_ENABLE_CANARY`                | `false`       |\n| `enablePrereleases`         | Enable prelrease builds                                        | `HELM_PLUGIN_ENABLE_PRERELEASE`            | `false`       |\n| `replaceVersionString`      | Replace version placeholder with current version               | `HELM_PLUGIN_REPLACE_VERSION_STRING`       | `true`        |\n| `replaceFileWithRepository` | Replace local file references with remote repository reference | `HELM_PLUGIN_REPLACE_FILE_WITH_REPOSITORY` | `false`       |\n| `repository`                | Repository to replace file references with                     | `HELM_PLUGIN_REPOSITORY`                   | `''`          |\n| `versionString`             | Default version string to replace                              | `HELM_PLUGIN_VERSION_STRING`               | `0.0.0-local` |\n| `useHelmDocs`               | Use `helm-docs` to update `README.md`                          | `HELM_PLUGIN_USE_HELM_DOCS`                | `false`       |\n| `publishPath`               | Local path to use for packaged charts                          | `HELM_PLUGIN_PUBLISH_PATH`                 | `publish`     |\n| `publishRepository`         | Repository to publish to                                       | `HELM_PLUGIN_PUBLISH_REPOSITORY`           | `publish`     |\n\nIf you are pushing to chart museum (set `push` or `HELM_PLUGIN_PUSH` to `true`) you can also set auth with these environment variables (additional environment variables can be found in the [docs](https://github.com/norwoodj/helm-docs)):\n\n- `HELM_REPO_USERNAME`\n- `HELM_REPO_PASSWORD`\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/ejhayes\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/310233?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eEric Hayes\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/ejhayes/auto-plugin-helm-chartmuseum/commits?author=ejhayes\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#infra-ejhayes\" title=\"Infrastructure (Hosting, Build-Tools, etc)\"\u003e🚇\u003c/a\u003e \u003ca href=\"https://github.com/ejhayes/auto-plugin-helm-chartmuseum/commits?author=ejhayes\" title=\"Tests\"\u003e⚠️\u003c/a\u003e \u003ca href=\"https://github.com/ejhayes/auto-plugin-helm-chartmuseum/commits?author=ejhayes\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fejhayes%2Fauto-plugin-helm-chartmuseum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fejhayes%2Fauto-plugin-helm-chartmuseum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fejhayes%2Fauto-plugin-helm-chartmuseum/lists"}