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 guard to multiple GitHub Actions workflows so that most CI jobs are skipped when a pull request title contains the marker string "[citest_skip]".

Sequence diagram for CI job skipping when PR title contains citest_skip marker

sequenceDiagram
  actor Developer
  participant GitHub
  participant Workflow_ansible_lint as ansible-lint.yml_job
  participant Workflow_codespell as codespell.yml_job

  Developer->>GitHub: Create or update pull request (with or without [citest_skip] in title)
  GitHub-->>Workflow_ansible_lint: Trigger workflow with pull_request event
  GitHub-->>Workflow_codespell: Trigger workflow with pull_request event

  alt Title contains [citest_skip]
    Workflow_ansible_lint->>Workflow_ansible_lint: Evaluate if !contains(title, [citest_skip])
    Workflow_ansible_lint-->>GitHub: Condition false, job skipped

    Workflow_codespell->>Workflow_codespell: Evaluate if !contains(title, [citest_skip])
    Workflow_codespell-->>GitHub: Condition false, job skipped
  else Title does not contain [citest_skip]
    Workflow_ansible_lint->>Workflow_ansible_lint: Evaluate if !contains(title, [citest_skip])
    Workflow_ansible_lint-->>GitHub: Condition true, run job steps

    Workflow_codespell->>Workflow_codespell: Evaluate if !contains(title, [citest_skip])
    Workflow_codespell-->>GitHub: Condition true, run job steps
  end

Loading

File-Level Changes

Change	Details	Files
Conditionally disable most CI jobs when a PR is marked to skip CI via its title.	Added an if: "!contains(github.event.pull_request.title, '[citest_skip]')" condition to each affected GitHub Actions job so they only run when the PR title does not include the skip marker Applied this condition consistently across ansible-lint, ansible-managed-var-comment, ansible-test, codespell, markdownlint, qemu-kvm integration tests, README conversion tests, and woke workflows	.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:

• For workflows that are also triggered by non-PR events (e.g., push), github.event.pull_request will be undefined and the current if will fail; consider guarding on github.event_name first, e.g. if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]').
• If you intend this to be a general convention across repositories, you might want to centralize the skip logic (e.g., via a reusable workflow or a shared expression pattern) to avoid repeating the literal [citest_skip] condition in every job and to keep behavior consistent.

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`), `github.event.pull_request` will be undefined and the current `if` will fail; consider guarding on `github.event_name` first, e.g. `if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')`.
- If you intend this to be a general convention across repositories, you might want to centralize the skip logic (e.g., via a reusable workflow or a shared expression pattern) to avoid repeating the literal `[citest_skip]` condition in every job and to keep behavior consistent.

---

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