Fix circular dependency in CI
Open
Nobody has claimed this yet.
ci
- Dominant language
- Markdown
- Stars
- 46
- Forks
- 40
- Avg merge
- 4h 3m
- Merged PRs (30d)
- 6
Description
Right now we commit docs changes, which breaks CI b/c a GHA commit will not trigger other actions. This is confusing for contributors because it looks like CI just isn't running.
Some other options:
- see what options there are in the GHA world to allow this
- fail instead of auto-commit w/ guidance on how to fix the failure (this requires folks to install
helm-docslocally, maybe we could have a manually triggered action, etc.) - something else?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the GitHub Actions workflow that commits documentation changes and review how helm-docs is invoked. Compare the proposed trigger and failure-handling options; done means the chosen approach prevents documentation commits from suppressing subsequent actions and clearly guides contributors when CI cannot proceed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100