jetstack / jetstack/version-checker

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

オープン
#231 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement
主要言語
Go
スター
778
フォーク
82
平均マージ
2分
マージ済み PR(30日)
3

説明

**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.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
kubernetes
領域
ci-cd, documentation
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。