As a doc-only contributor I would like to have the full CI skipped
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 598
- Forks
- 168
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 86
Description
Is your feature request related to a problem? Please describe.
When contributing doc-only changes, the full CI is unnecessarily triggered, which is a waste of time and resources.
Describe the solution you'd like
Following up on the doc-workgroup discussions around making doc contributions smooth, it would be nice if doc-only changes would not trigger the full CI test suite.
By "doc-only changes" I mean a PR in which all the affected files belong to the docs folder (or some similar safe-filter strategy).
Describe alternatives you've considered
None.
Additional context
If that helps, I've done something similar in dynaconf here (based on github docs).
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
Review the repository’s existing GitHub Actions workflows and the referenced .github/workflows/doc-ignore.yml example. Determine how a PR whose affected files are all under the docs folder can avoid the full suite while preserving required checks, then verify the workflow behavior for documentation-only and mixed-content changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100