{"id":31818893,"url":"https://github.com/losisin/helm-docs-github-action","last_synced_at":"2025-10-11T11:21:32.092Z","repository":{"id":207396891,"uuid":"719077775","full_name":"losisin/helm-docs-github-action","owner":"losisin","description":"Install helm-docs tool and auto-generate markdown documentation from Helm charts","archived":false,"fork":false,"pushed_at":"2025-09-29T11:16:03.000Z","size":1979,"stargazers_count":10,"open_issues_count":1,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-29T13:19:24.154Z","etag":null,"topics":["documentation","gh-actions","github-actions","helm","helm-chart","helm-charts","helm-docs","markdown"],"latest_commit_sha":null,"homepage":"","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/losisin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"losisin"}},"created_at":"2023-11-15T12:04:40.000Z","updated_at":"2025-09-29T11:16:07.000Z","dependencies_parsed_at":"2023-12-25T08:24:02.820Z","dependency_job_id":"d266927a-72b7-485f-b9f9-5d77267aff7c","html_url":"https://github.com/losisin/helm-docs-github-action","commit_stats":null,"previous_names":["losisin/helm-docs-github-action"],"tags_count":38,"template":false,"template_full_name":null,"purl":"pkg:github/losisin/helm-docs-github-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/losisin%2Fhelm-docs-github-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/losisin%2Fhelm-docs-github-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/losisin%2Fhelm-docs-github-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/losisin%2Fhelm-docs-github-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/losisin","download_url":"https://codeload.github.com/losisin/helm-docs-github-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/losisin%2Fhelm-docs-github-action/sbom","scorecard":{"id":389679,"data":{"date":"2025-08-11","repo":{"name":"github.com/losisin/helm-docs-github-action","commit":"9c95a91d36a92740239fa5fce21bb0c05ae1a810"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":7.3,"checks":[{"name":"Code-Review","score":6,"reason":"Found 3/5 approved changesets -- score normalized to 6","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"28 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":9,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yaml:17","Warn: jobLevel 'checks' permission set to 'write': .github/workflows/codeql-analysis.yaml:18","Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yaml:19","Info: topLevel 'contents' permission set to 'read': .github/workflows/check-dist.yaml:17","Info: topLevel 'contents' permission set to 'read': .github/workflows/ci.yaml:10","Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yaml:1"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":4,"reason":"dependency not pinned by hash detected -- score normalized to 4","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check-dist.yaml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/losisin/helm-docs-github-action/check-dist.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check-dist.yaml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/losisin/helm-docs-github-action/check-dist.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check-dist.yaml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/losisin/helm-docs-github-action/check-dist.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/losisin/helm-docs-github-action/ci.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/losisin/helm-docs-github-action/ci.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/losisin/helm-docs-github-action/ci.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/losisin/helm-docs-github-action/ci.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yaml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/losisin/helm-docs-github-action/codeql-analysis.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yaml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/losisin/helm-docs-github-action/codeql-analysis.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yaml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/losisin/helm-docs-github-action/codeql-analysis.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yaml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/losisin/helm-docs-github-action/codeql-analysis.yaml/main?enable=pin","Info:   0 out of  10 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   2 out of   2 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":10,"reason":"SAST tool is run on all commits","details":["Info: SAST configuration detected: CodeQL","Info: all commits (30) are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T17:30:55.012Z","repository_id":207396891,"created_at":"2025-08-18T17:30:55.012Z","updated_at":"2025-08-18T17:30:55.012Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279007043,"owners_count":26084227,"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-10-11T02:00:06.511Z","response_time":55,"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":["documentation","gh-actions","github-actions","helm","helm-chart","helm-charts","helm-docs","markdown"],"created_at":"2025-10-11T11:21:30.786Z","updated_at":"2025-10-11T11:21:32.086Z","avatar_url":"https://github.com/losisin.png","language":"TypeScript","funding_links":["https://github.com/sponsors/losisin"],"categories":[],"sub_categories":[],"readme":"# Helm Docs GitHub Action\n\n[![CI](https://github.com/losisin/helm-docs-github-action/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/losisin/helm-docs-github-action/actions/workflows/ci.yaml)\n[![codecov](https://codecov.io/gh/losisin/helm-docs-github-action/graph/badge.svg?token=0QQVCFJH84)](https://codecov.io/gh/losisin/helm-docs-github-action)\n[![Static Badge](https://img.shields.io/badge/licence%20-%20MIT-green)](https://github.com/losisin/helm-docs-github-action/blob/main/LICENSE)\n[![GitHub release (with filter)](https://img.shields.io/github/v/release/losisin/helm-docs-github-action)](https://github.com/losisin/helm-docs-github-action/releases)\n\nInstall [helm-docs](https://github.com/norwoodj/helm-docs) tool and auto-generate Markdown documentation from Helm charts. It always uses latest version of `helm-docs`.\n\n## Usage\n\nTo use this action, add the following step to your workflow:\n\n```yaml\nname: Generate Helm documentation\non:\n  - pull_request\njobs:\n  generate:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n        with:\n          repository: ${{ github.event.pull_request.head.repo.full_name }}\n          ref: ${{ github.event.pull_request.head.ref }}\n      - name: Run helm-docs\n        uses: losisin/helm-docs-github-action@v1\n```\n\n\u003e [!NOTE]\n\u003e This will only generate Markdown documentation but no further action will be taken.\n\n## Inputs\n\n| Name | Description | Default | Required |\n|------|-------------|---------|----------|\n| `chart-search-root` | The root directory to search recursively within for charts | `.` | false |\n| `values-file` | Path to values file | `values.yaml` | false |\n| `output-file` | Markdown file path relative to each chart directory to which rendered documentation will be written | `README.md` | false |\n| `template-files` | Comma separated list of template files to render | `README.md.gotmpl` | false |\n| `sort-values-order` | Order in which to sort the values table | unset | false |\n| `skip-version-footer` | If true the helm-docs version footer will not be shown in the default README template | false | false |\n| `git-push` | If true it will commit and push the changes (ignored if `fail-on-diff` is set) | `false` | false |\n| `git-push-user-name` | If empty the name of the GitHub Actions bot will be used | `github-actions[bot]` | false |\n| `git-push-user-email` | If empty the no-reply email of the GitHub Actions bot will be used | `github-actions[bot]@users.noreply.github.com` | false |\n| `git-commit-message` | Commit message | `update Helm documentation` | false |\n| `fail-on-diff` | Fail the job if there is any diff found between the generated output and existing file | `false` | false |\n| `version` | The version of helm-docs to install and use | `v1.14.2` | false |\n\n## Outputs\n\n| Name | Description |\n|------|-------------|\n| `plugin-path` | Path to the cached helm-docs binary |\n\n## Examples\n\n### Fail on diff\n\nTo fail the workflow if there is a diff between the generated documentation and the committed one, add the following step to your workflow:\n\n```yaml\nname: Generate Helm documentation\non:\n  - pull_request\njobs:\n  generate:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n        with:\n          repository: ${{ github.event.pull_request.head.repo.full_name }}\n          ref: ${{ github.event.pull_request.head.ref }}\n      - name: Run helm-docs\n        uses: losisin/helm-docs-github-action@v1\n        with:\n          fail-on-diff: true\n```\n\n\n### Auto commit generated documentation\n\n\u003e [!NOTE]\n\u003e For pull requests from a forked repo to the base repo,\n\u003e `git-push` will fail to push to the forked repo,\n\u003e unless you pass `Personal access tokens` of the forked repo owners\n\u003e to the base repo and map them to `head.repo`.\n\u003e Consider using `fail-on-diff: true` in this case.\n\n\u003e [!NOTE]\n\u003e The `git-push` option is ignored if `fail-on-diff: true`.\n\nTo automatically commit the generated documentation, add the following step to your workflow:\n\n```yaml\nname: Generate Helm documentation\non:\n  - pull_request\njobs:\n  generate:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n        with:\n          repository: ${{ github.event.pull_request.head.repo.full_name }}\n          ref: ${{ github.event.pull_request.head.ref }}\n      - name: Run helm-docs\n        uses: losisin/helm-docs-github-action@v1\n        with:\n          git-push: true\n```\n\nTo overwrite default user and email which is set to `github-actions[bot]` and add custom commit message, add the following:\n\n```yaml\nname: Generate Helm documentation\non:\n  - pull_request\njobs:\n  generate:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n        with:\n          repository: ${{ github.event.pull_request.head.repo.full_name }}\n          ref: ${{ github.event.pull_request.head.ref }}\n      - name: Run helm-docs\n        uses: losisin/helm-docs-github-action@v1\n        with:\n          input: values.yaml\n          git-push: true\n          git-push-user-name: \"John Doe\"\n          git-push-user-email: \"john.doe@example.com\"\n          git-commit-message: \"chore: update Helm documentation\"\n```\n\n## Issues, Features, Feedback\n\nYour input matters. Feel free to open [issues](https://github.com/losisin/helm-docs-github-action/issues) for bugs, feature requests, or any feedback you may have. Check if a similar issue exists before creating a new one, and please use clear titles and explanations to help understand your point better. Your thoughts help me improve this project!\n\n### How to Contribute\n\n🌟 Thank you for considering contributing to my project! Your efforts are incredibly valuable. To get started:\n\n1. Fork the repository.\n2. Create your feature branch: `git checkout -b feature/YourFeature`\n3. Commit your changes: `git commit -am 'Add: YourFeature'`\n4. Push to the branch: `git push origin feature/YourFeature`\n5. Submit a pull request! 🚀\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flosisin%2Fhelm-docs-github-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flosisin%2Fhelm-docs-github-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flosisin%2Fhelm-docs-github-action/lists"}