jetstack / jetstack/version-checker
[FEATURE] CI - stop PR's where helm-docs hasn't run
- Dominant language
- Go
- Stars
- 778
- Forks
- 82
- Avg merge
- 2m
- Merged PRs (30d)
- 3
Description
**Is your feature request related to a problem? Please describe.**
Stop PR's where helm-docs hasn't run
**Describe the solution you'd like**
In PR CI, run helm-docs and fail if changes are detected.
**Describe alternatives you've considered**
Many headaches.
**Additional context**
Discussed on version-checker meeting 2024/08/15
---
**Message from the maintainers**:
If you wish to see this enhancement implemented please add a 👍 reaction to this issue! We often sort issues this way to know what to prioritize.
Contributor guide
Research direction
Start by locating the repository's PR CI workflow and existing helm-docs configuration. Run helm-docs in CI, compare the generated files with the working tree, and make the check fail when changes are detected; done means a PR with ungenerated documentation is rejected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100