DOC, CI: Add a "skip" option to only run docs-related CI checks
Open
Nobody has claimed this yet.
04 - Documentation
component: CI
triage review
- Dominant language
- Python
- Stars
- 32.8k
- Forks
- 12.8k
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 197
Description
Currently, for a regular docs PR we should not skip GitHub actions since that is where the artifacts redirector job is run.
We could add a [docs only] CI option that is equivalent to running only CircleCI, i.e.
[skip azp][skip cirrus][skip travis][skip actions]
but runs the artifacts redirector job.
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 reading .github/workflows/circleci.yml and trace how CI skip options are interpreted across the listed providers. Confirm how a [docs only] option could skip Azure Pipelines, Cirrus, Travis, and Actions while preserving the artifacts redirector job; done means the option produces that behavior in a regular docs PR.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100