numpy icon indicating copy to clipboard operation
numpy copied to clipboard

DOC, CI: Add a "skip" option to only run docs-related CI checks

Open melissawm opened this issue 2 years ago • 4 comments

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.

melissawm avatar Aug 29 '23 02:08 melissawm

When using [skip azp][skip cirrus][skip travis][skip actions] on the last commit on #24138, the redirector shows up, so maybe all we need is an alias. But wouldn't processing the alias require running some CI?

mattip avatar Aug 29 '23 05:08 mattip

Travis CI is already gone, and hopefully Azure will soon be gone to. In that case we'd need [skip cirrus] [skip actions]. That could be aliased, but that then indeed requires more logic, so it may not be worth it. In particular, on GHA we'd need a "check skip" job that runs before every other job, like we have now on Azure.

One related thing I've been thinking about is automatically checking if it's a docs-only PR, and skipping jobs based on that. It would also need trigger logic, which has the same problem as a [docs only] label. But it'd probably be more useful, since so many doc PRs are made by new contributors who aren't going to use the magic snippet in a commit message.

rgommers avatar Aug 29 '23 06:08 rgommers

Any update on a [docs only] option? I've seen it show up in some commits, but don't know if it's been added yet. I love the idea of an automatic check. Is there still interest?

bmwoodruff avatar Jun 09 '25 23:06 bmwoodruff

Let me work some more on it. I can probably make some progress this week.

https://github.com/numpy/numpy/pull/26316

melissawm avatar Jun 10 '25 16:06 melissawm