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

Configures most GitHub Actions jobs to be conditionally skipped when a pull request title contains the marker "[citest_skip]" to avoid running heavy CI pipelines for CI/docs-only changes.

Sequence diagram for PR event and conditional CI job execution

sequenceDiagram
  actor Developer
  participant GitHub as GitHub_Repo
  participant Actions as GitHub_Actions
  participant Workflow as CI_Workflow
  participant Job as CI_Job

  Developer->>GitHub: Create or update PR with title
  GitHub-->>Actions: Emit pull_request event
  Actions->>Workflow: Start workflow evaluation
  Workflow->>Workflow: Read github.event.pull_request.title
  Workflow->>Workflow: Evaluate condition !contains(title, [citest_skip])
  alt Title does not contain [citest_skip]
    Workflow->>Job: Schedule CI job execution
    Job-->>Workflow: Run checks (lint, spelling, etc.)
  else Title contains [citest_skip]
    Workflow-->>Job: Do not start job (skipped)
  end
  Workflow-->>Actions: Report job status to GitHub
  Actions-->>Developer: Display CI results on PR

Loading

File-Level Changes

Change	Details	Files
Gate all major CI GitHub Actions jobs on a PR-title flag to allow skipping heavy checks.	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 skip marker. Add the same title-based if condition to the ansible_managed_var_comment job to skip it on citest-only PRs. Apply the title-based if condition to the ansible_test job to avoid running the full Ansible test suite when skipping CI. Guard the codespell job with the title-based if condition to skip spelling checks when requested. Guard the markdownlint job with the title-based if condition to skip markdown linting when requested. Guard the scenario job in the qemu-kvm-integration-tests workflow with the title-based if condition to skip integration tests when requested. Guard the test_converting_readme job with the title-based if condition to avoid running README conversion tests when skipping CI. Guard the woke job with the title-based if condition to skip non-inclusive language checks on citest-only PRs.	.github/workflows/ansible-lint.yml .github/workflows/ansible-managed-var-comment.yml .github/workflows/ansible-test.yml .github/workflows/codespell.yml .github/workflows/markdownlint.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:

• To make the condition more explicit and robust for non-PR events, consider changing the job-level if to something like if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]') so that pushes and other event types are clearly unaffected and not relying on contains handling null.
• Relying on a magic string in the PR title can be fragile (typos, different casing, etc.); you might want to consider using a dedicated PR label (and checking github.event.pull_request.labels) instead, which is easier to enforce via tooling or repository conventions.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- To make the condition more explicit and robust for non-PR events, consider changing the job-level `if` to something like `if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')` so that pushes and other event types are clearly unaffected and not relying on `contains` handling null.
- Relying on a magic string in the PR title can be fragile (typos, different casing, etc.); you might want to consider using a dedicated PR label (and checking `github.event.pull_request.labels`) instead, which is easier to enforce via tooling or repository conventions.

---

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