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

Sequence diagram for conditional CI execution based on PR title

sequenceDiagram
  actor Developer
  participant GitHub
  participant Workflow_ansible_lint
  participant Workflow_codespell
  participant Workflow_shellcheck

  Developer->>GitHub: Open pull_request(title)
  GitHub-->>Workflow_ansible_lint: Trigger workflow with event pull_request
  GitHub-->>Workflow_codespell: Trigger workflow with event pull_request
  GitHub-->>Workflow_shellcheck: Trigger workflow with event pull_request

  alt PR title contains [citest_skip]
    Workflow_ansible_lint-->>Workflow_ansible_lint: if !contains(title, [citest_skip]) is false
    Workflow_codespell-->>Workflow_codespell: if !contains(title, [citest_skip]) is false
    Workflow_shellcheck-->>Workflow_shellcheck: if !contains(title, [citest_skip]) is false
    Workflow_ansible_lint-->>GitHub: Job skipped
    Workflow_codespell-->>GitHub: Job skipped
    Workflow_shellcheck-->>GitHub: Job skipped
  else PR title does not contain [citest_skip]
    Workflow_ansible_lint-->>Workflow_ansible_lint: if !contains(title, [citest_skip]) is true
    Workflow_codespell-->>Workflow_codespell: if !contains(title, [citest_skip]) is true
    Workflow_shellcheck-->>Workflow_shellcheck: if !contains(title, [citest_skip]) is true
    Workflow_ansible_lint->>GitHub: Run CI checks
    Workflow_codespell->>GitHub: Run CI checks
    Workflow_shellcheck->>GitHub: Run CI checks
  end

Loading

File-Level Changes

Change	Details	Files
Conditionally skip most CI workflows based on a PR title marker.	Add an if: "!contains(github.event.pull_request.title, '[citest_skip]')" condition to the main job in each workflow so jobs only run when the PR title does not include the citest skip marker Apply the conditional guard consistently across linting, testing, code analysis, documentation, and integration test workflows to reduce unnecessary CI load for CI/docs-only PRs	.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:

• In codeql.yml the job-level condition directly accesses github.event.pull_request.title, which will be undefined for push and schedule events; consider guarding by event type (e.g. if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')) so CodeQL analysis still runs for non-PR triggers.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- In `codeql.yml` the job-level condition directly accesses `github.event.pull_request.title`, which will be undefined for `push` and `schedule` events; consider guarding by event type (e.g. `if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')`) so CodeQL analysis still runs for non-PR triggers.

---

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