Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
melissawm opened this issue Aug 29, 2023 · 4 comments
Open

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

melissawm opened this issue Aug 29, 2023 · 4 comments

Comments

@melissawm
Copy link
Member

melissawm commented Aug 29, 2023

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.

@mattip
Copy link
Member

mattip commented Aug 29, 2023

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?

@rgommers
Copy link
Member

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.

@bmwoodruff
Copy link
Member

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?

@melissawm
Copy link
Member Author

melissawm commented Jun 10, 2025

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

#26316

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants