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

This PR updates all major GitHub Actions workflows to conditionally skip running jobs when a pull request title includes the marker "[citest_skip]", reducing unnecessary CI load for CI/docs-only changes.

Flow diagram for CI job execution decision using citest_skip

flowchart TD
  PR[PR_opened_or_updated]
  Title[Read_PR_title]
  CheckTitle{"Does_title_contain_[citest_skip]?"}

  PR --> Title --> CheckTitle

  CheckTitle -- Yes --> Skip[Skip_all_citest_skip_guarded_jobs]
  CheckTitle -- No --> Run[Run_all_standard_CI_jobs]

  subgraph Guarded_jobs_examples
    G1[ansible_lint_job]
    G2[ansible_managed_var_comment_job]
    G3[codeql_analyze_job]
    G4[codespell_job]
    G5[markdownlint_job]
    G6[woke_job]
  end

  Run --> G1
  Run --> G2
  Run --> G3
  Run --> G4
  Run --> G5
  Run --> G6

Loading

File-Level Changes

Change	Details	Files
Add a conditional guard to each CI workflow job so it only runs if the pull request title does not contain "[citest_skip]".	Add an if: "!contains(github.event.pull_request.title, '[citest_skip]')" condition at the job level for each workflow job. Apply the same title-based skip condition consistently across linting, testing, static analysis, spell checking, markdown linting, integration tests, README conversion tests, and inclusive-language checks.	.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/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 found 1 issue, and left some high level feedback:

• In workflows that can be triggered by non–pull_request events (e.g., codeql.yml with push and schedule), referencing github.event.pull_request.title will fail; guard the condition with an event check (e.g., if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')).
• Consider centralizing the [citest_skip] condition via a reusable workflow or a shared expression pattern to avoid duplicating the same if logic across many jobs and workflows.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- In workflows that can be triggered by non–pull_request events (e.g., codeql.yml with push and schedule), referencing github.event.pull_request.title will fail; guard the condition with an event check (e.g., `if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')`).
- Consider centralizing the `[citest_skip]` condition via a reusable workflow or a shared expression pattern to avoid duplicating the same `if` logic across many jobs and workflows.

## Individual Comments

### Comment 1
<location> `.github/workflows/codeql.yml:17` </location>
<code_context>
   contents: read
 jobs:
   ansible_lint:
+    if: "!contains(github.event.pull_request.title, '[citest_skip]')"
     runs-on: ubuntu-latest
     steps:
</code_context>

<issue_to_address>
**issue (bug_risk):** Guard against non-pull_request events to avoid potential evaluation errors on scheduled runs.

Because this workflow also runs on `schedule`, `github.event.pull_request` is undefined for those executions. Using it directly in `contains` can cause unintended skips or even workflow failures. Please guard on the event type or the null case, for example:

```yaml
if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')
```

or:

```yaml
if: !github.event.pull_request || !contains(github.event.pull_request.title, '[citest_skip]')
```
</issue_to_address>

---

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