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

Update CI workflows to support skipping most checks when the PR title (or push commit message) contains the marker [citest_skip], and consolidate the skip condition logic across workflows.

Sequence diagram for GitHub Actions job execution with citest_skip

sequenceDiagram
  actor Developer
  participant GitHub as GitHub_Actions
  participant Workflow as Workflow_job

  Developer->>GitHub: Open_pull_request_or_push_commit
  GitHub->>GitHub: Evaluate_event_name
  alt Pull_request_event
    GitHub->>GitHub: Check_PR_title_for_citest_skip
  else Push_event
    GitHub->>GitHub: Check_head_commit_message_for_citest_skip
  end
  alt Contains_citest_skip
    GitHub-->>Developer: Mark_job_as_skipped
  else Does_not_contain_citest_skip
    GitHub->>Workflow: Start_job_execution
    Workflow-->>Developer: Run_CI_checks
  end

Loading

Flow diagram for CI job skip condition based on citest_skip

flowchart TD
  A[GitHub_event_received] --> B{event_name}
  B -->|pull_request| C[Check_PR_title_for_citest_skip]
  B -->|push| D[Check_head_commit_message_for_citest_skip]

  C --> E{title_contains_citest_skip}
  D --> F{message_contains_citest_skip}

  E -->|yes| G[Set_job_condition_false_skip_job]
  E -->|no| H[Set_job_condition_true_run_job]

  F -->|yes| G
  F -->|no| H

Loading

File-Level Changes

Change	Details	Files
Unify and extend CI skip conditions so jobs are skipped for both pull_request titles and push head commit messages containing [citest_skip].	Replace simple pull_request-title-only conditions with a compound if expression that checks both github.event_name and the presence of [citest_skip] in the relevant field. Apply the new condition to ansible-managed-var-comment, ansible-test, codespell, markdownlint, qemu-kvm integration tests, test_converting_readme, and woke workflows. Remove outdated comments in ansible-lint workflow since the logic is now self-explanatory and consistent with other workflows.	.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 .github/workflows/ansible-lint.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:

• The [citest_skip] condition is duplicated verbatim across several workflows; consider extracting this into a reusable workflow or a shared expression (e.g., via workflow_call or a single called workflow) so future changes only need to be updated in one place.
• In woke.yml (and any other workflows that only trigger on pull_request), the push branch of the if condition is never used, so you could simplify those specific if expressions to only check the PR title for better readability.
• You removed the explanatory comment in ansible-lint.yml but added the same logic to other workflows without any explanation; consider keeping a brief inline comment near the first usage of this condition pattern to clarify its purpose for future maintainers.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The `[citest_skip]` condition is duplicated verbatim across several workflows; consider extracting this into a reusable workflow or a shared expression (e.g., via `workflow_call` or a single called workflow) so future changes only need to be updated in one place.
- In `woke.yml` (and any other workflows that only trigger on `pull_request`), the `push` branch of the `if` condition is never used, so you could simplify those specific `if` expressions to only check the PR title for better readability.
- You removed the explanatory comment in `ansible-lint.yml` but added the same logic to other workflows without any explanation; consider keeping a brief inline comment near the first usage of this condition pattern to clarify its purpose for future maintainers.

## Individual Comments

### Comment 1
<location> `.github/workflows/woke.yml:7-11` </location>
<code_context>
-  # do not run the pipeline if this is a pull request and the title contains [citest_skip],
-  # or if this is a push and the head commit message contains [citest_skip]
   ansible_lint:
     if: |
       !((github.event_name == 'pull_request' && contains(github.event.pull_request.title, '[citest_skip]')) ||
</code_context>

<issue_to_address>
**suggestion:** The `push` branch of the condition in this workflow appears unnecessary given it only triggers on `pull_request`.

Because this workflow only listens to `pull_request` events, `github.event_name` can never be `push` here, so that branch is dead code. Removing it will simplify the condition and avoid suggesting this workflow runs on pushes.

```suggestion
  woke:
    if: |
      !(github.event_name == 'pull_request' && contains(github.event.pull_request.title, '[citest_skip]'))
    name: Detect non-inclusive language
```
</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.}