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

Add a conditional guard to most GitHub Actions CI workflows so that their jobs are skipped when the pull request title contains the substring "[citest_skip]".

Sequence diagram for GitHub Actions job execution with [citest_skip] in PR title

sequenceDiagram
  actor Developer
  participant GitHub
  participant Workflow_ansible_lint
  participant Workflow_codespell
  participant Workflow_markdownlint
  participant Workflow_codeql
  participant Workflow_woke

  Developer->>GitHub: Open or update pull request
  GitHub->>GitHub: Read github.event.pull_request.title

  alt PR title contains [citest_skip]
    GitHub->>Workflow_ansible_lint: Evaluate if condition
    Workflow_ansible_lint-->>GitHub: Condition false, job skipped

    GitHub->>Workflow_codespell: Evaluate if condition
    Workflow_codespell-->>GitHub: Condition false, job skipped

    GitHub->>Workflow_markdownlint: Evaluate if condition
    Workflow_markdownlint-->>GitHub: Condition false, job skipped

    GitHub->>Workflow_codeql: Evaluate if condition
    Workflow_codeql-->>GitHub: Condition false, job skipped

    GitHub->>Workflow_woke: Evaluate if condition
    Workflow_woke-->>GitHub: Condition false, job skipped
  else PR title does not contain [citest_skip]
    GitHub->>Workflow_ansible_lint: Start job ansible_lint
    Workflow_ansible_lint-->>GitHub: Run CI steps

    GitHub->>Workflow_codespell: Start job codespell
    Workflow_codespell-->>GitHub: Run CI steps

    GitHub->>Workflow_markdownlint: Start job markdownlint
    Workflow_markdownlint-->>GitHub: Run CI steps

    GitHub->>Workflow_codeql: Start job analyze
    Workflow_codeql-->>GitHub: Run CI steps

    GitHub->>Workflow_woke: Start job woke
    Workflow_woke-->>GitHub: Run CI steps
  end

Loading

File-Level Changes

Change	Details	Files
Conditionally skip ansible-related CI jobs based on PR title marker.	Add an if: "!contains(github.event.pull_request.title, '[citest_skip]')" condition to the ansible_lint job so it only runs when the PR title does not include the citest skip marker. Add the same conditional if expression to the ansible_managed_var_comment job. Guard the ansible_test job with the same PR-title-based condition.	.github/workflows/ansible-lint.yml .github/workflows/ansible-managed-var-comment.yml .github/workflows/ansible-test.yml
Conditionally skip static analysis and spelling CI jobs when citest skip marker is present.	Add the PR-title-based if condition to the analyze job in the CodeQL workflow so it can be skipped for CI-only/docs changes. Add the same condition to the codespell job to avoid running spelling checks when citest skip is requested. Guard the markdownlint job with the same if expression to skip markdown linting when appropriate.	.github/workflows/codeql.yml .github/workflows/codespell.yml .github/workflows/markdownlint.yml
Conditionally skip Python unit tests, QEMU integration tests, README conversion tests, and inclusive-language checks when citest skip marker is present.	Add the PR-title-based if condition to the python job in the Python unit test workflow. Add the same if condition to the scenario job in the QEMU/KVM integration tests workflow. Guard the test_converting_readme job with the PR-title condition to skip README conversion checks. Apply the same PR-title-based if condition to the woke job for inclusive-language detection.	.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:

• For workflows that are also triggered by non-PR events (e.g., push, schedule in codeql.yml), referencing github.event.pull_request.title can be undefined; consider guarding the condition with github.event_name == 'pull_request' to avoid evaluation issues, e.g. if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]').
• Since the same skip condition is duplicated across many jobs, consider extracting it into a common pattern (e.g., top-level if per workflow or a reusable workflow) to keep things consistent and easier to maintain if the rule changes.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- For workflows that are also triggered by non-PR events (e.g., `push`, `schedule` in `codeql.yml`), referencing `github.event.pull_request.title` can be undefined; consider guarding the condition with `github.event_name == 'pull_request'` to avoid evaluation issues, e.g. `if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')`.
- Since the same skip condition is duplicated across many jobs, consider extracting it into a common pattern (e.g., top-level `if` per workflow or a reusable workflow) to keep things consistent and easier to maintain if the rule changes.

---

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.}