jetstack / jetstack/version-checker

[FEATURE] CI - stop PR's where helm-docs hasn't run

Ouverte
#231 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
enhancement
Langage dominant
Go
Étoiles
778
Forks
82
Merge moyen
2 min
PR mergées (30 j)
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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
kubernetes
Domaine
ci-cd, documentation
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.