rstudio / rstudio/helm

Fix circular dependency in CI

Open
#320 0 comments 0 reactions 0 assignees View on GitHub

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-docs locally, maybe we could have a manually triggered action, etc.)
  • something else?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.