ci: skip most CI checks if title contains citest skip [citest_skip]

[richm]

When we submit a PR for a CI update or docs, we do not want to start CI checking
for ansible-lint, qemu, etc. When we are doing CI updates to 30 or more
roles, this fires off a lot of unnecessary tests, which sometimes causes the
linux-system-roles org in github to be throttled.

When submitting a PR that can skip ci, use "[citest_skip]" in the PR title.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds a conditional to multiple GitHub Actions workflows so that most CI jobs are skipped when a pull request title contains the marker "[citest_skip]".

Flow diagram for CI job execution based on PR title marker

flowchart TD
  A[PR_opened] --> B[Read_PR_title]
  B --> C{Title_contains_citest_skip_marker}
  C -- Yes --> D[Skip_selected_CI_jobs<br/>ansible_lint<br/>ansible_managed_var_comment<br/>codeql<br/>codespell<br/>markdownlint<br/>woke]
  C -- No --> E[Run_all_configured_CI_jobs]

  D --> F[PR_checks_complete]
  E --> F

Loading

File-Level Changes

Change	Details	Files
Conditionally skip most CI workflows based on a PR title marker to avoid running heavy checks on CI/docs-only changes.	Add an if condition to each affected GitHub Actions job to check that the pull request title does not contain the string "[citest_skip]" Apply this condition consistently across linting, testing, static analysis, documentation-conversion, and language-check workflows	.github/workflows/ansible-lint.yml .github/workflows/ansible-managed-var-comment.yml .github/workflows/ansible-test.yml .github/workflows/codeql.yml .github/workflows/codespell.yml .github/workflows/markdownlint.yml .github/workflows/python-unit-test.yml .github/workflows/qemu-kvm-integration-tests.yml .github/workflows/test_converting_readme.yml .github/workflows/woke.yml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've left some high level feedback:

• Several workflows (e.g., codeql with a schedule trigger) can run on events other than pull_request, but the condition unconditionally references github.event.pull_request.title; consider guarding the check with github.event_name == 'pull_request' (e.g., if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')) to avoid runtime evaluation issues on non-PR events.
• If the intent is only to skip heavier jobs (e.g., ansible, qemu), you might want to revisit applying [citest_skip] to lighter, fast-running checks like markdownlint, codespell, or woke so that basic validation still runs even when full CI is skipped.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Several workflows (e.g., codeql with a `schedule` trigger) can run on events other than `pull_request`, but the condition unconditionally references `github.event.pull_request.title`; consider guarding the check with `github.event_name == 'pull_request'` (e.g., `if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')`) to avoid runtime evaluation issues on non-PR events.
- If the intent is only to skip heavier jobs (e.g., ansible, qemu), you might want to revisit applying `[citest_skip]` to lighter, fast-running checks like markdownlint, codespell, or woke so that basic validation still runs even when full CI is skipped.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}