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

Sequence diagram for conditional CI job execution based on PR title marker

sequenceDiagram
    actor Developer
    participant GitHub
    participant WorkflowDispatcher
    participant Job_ansible_lint
    participant Job_codespell
    participant Job_markdownlint

    Developer->>GitHub: Open pull_request with title containing [citest_skip]
    GitHub-->>WorkflowDispatcher: pull_request event

    WorkflowDispatcher->>Job_ansible_lint: Evaluate if !contains(title, [citest_skip])
    alt Title_contains_citest_skip
        Job_ansible_lint-->>WorkflowDispatcher: Condition false
        WorkflowDispatcher-->>Job_ansible_lint: Skip job
    else Title_does_not_contain_citest_skip
        Job_ansible_lint-->>WorkflowDispatcher: Condition true
        WorkflowDispatcher-->>Job_ansible_lint: Run job steps
    end

    WorkflowDispatcher->>Job_codespell: Evaluate if !contains(title, [citest_skip])
    alt Title_contains_citest_skip
        Job_codespell-->>WorkflowDispatcher: Condition false
        WorkflowDispatcher-->>Job_codespell: Skip job
    else Title_does_not_contain_citest_skip
        Job_codespell-->>WorkflowDispatcher: Condition true
        WorkflowDispatcher-->>Job_codespell: Run job steps
    end

    WorkflowDispatcher->>Job_markdownlint: Evaluate if !contains(title, [citest_skip])
    alt Title_contains_citest_skip
        Job_markdownlint-->>WorkflowDispatcher: Condition false
        WorkflowDispatcher-->>Job_markdownlint: Skip job
    else Title_does_not_contain_citest_skip
        Job_markdownlint-->>WorkflowDispatcher: Condition true
        WorkflowDispatcher-->>Job_markdownlint: Run job steps
    end

Loading

File-Level Changes

Change	Details	Files
Gate most GitHub Actions jobs on a PR title marker to allow skipping CI for certain pull requests.	Add an if: "!contains(github.event.pull_request.title, '[citest_skip]')" condition to each primary CI job so it only runs when the PR title does not include the skip marker Apply this condition consistently across linting, testing, static analysis, spell checking, documentation, and integration test workflows to minimize unnecessary CI load	.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/shellcheck.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, or any triggered on push) now reference github.event.pull_request.title, which is not defined for non-pull_request events; consider guarding the condition with github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]') to avoid runtime errors and unintended skips.
• If the intention is to skip all CI for these PRs, you may want to put the if condition at the workflow or a common job level (or via a shared reusable workflow) to avoid duplicating the [citest_skip] logic across many jobs and keep future changes to the skip behavior in one place.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Several workflows (e.g., codeql with a `schedule` trigger, or any triggered on `push`) now reference `github.event.pull_request.title`, which is not defined for non-`pull_request` events; consider guarding the condition with `github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')` to avoid runtime errors and unintended skips.
- If the intention is to skip all CI for these PRs, you may want to put the `if` condition at the workflow or a common job level (or via a shared reusable workflow) to avoid duplicating the `[citest_skip]` logic across many jobs and keep future changes to the skip behavior in one place.

---

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