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

Sequence diagram for conditional CI job execution based on PR title

sequenceDiagram
  actor Developer
  participant GitHub
  participant GitHubActions
  participant ansible_lint
  participant codespell
  participant markdownlint
  participant shellcheck
  participant woke

  Developer->>GitHub: Create or update pull_request
  GitHub-->>GitHubActions: emit pull_request event
  GitHubActions->>GitHubActions: Evaluate contains(github.event.pull_request.title, [citest_skip])

  alt Title contains [citest_skip]
    GitHubActions-->>ansible_lint: Skip job (if: !contains(...))
    GitHubActions-->>codespell: Skip job
    GitHubActions-->>markdownlint: Skip job
    GitHubActions-->>shellcheck: Skip job
    GitHubActions-->>woke: Skip job
  else Title does not contain [citest_skip]
    GitHubActions->>ansible_lint: Run job
    GitHubActions->>codespell: Run job
    GitHubActions->>markdownlint: Run job
    GitHubActions->>shellcheck: Run job
    GitHubActions->>woke: Run job
  end

Loading

File-Level Changes

Change	Details	Files
Conditionally skip CI jobs when PR title contains the marker string.	Add an if: "!contains(github.event.pull_request.title, '[citest_skip]')" condition to each workflow job so it only runs when the PR title does not request skipping CI Apply the same title-based condition across all primary CI workflows including linting, tests, spell checks, markdown checks, integration tests, shellcheck, 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/codespell.yml .github/workflows/markdownlint.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:

• These if: "!contains(github.event.pull_request.title, '[citest_skip]')" conditions will fail on non-pull_request events (e.g. push) where github.event.pull_request is undefined; consider guarding with github.event_name == 'pull_request' && !contains(...) or similar.
• Since the same if condition is duplicated across multiple workflow files, consider extracting this into a reusable workflow or a shared convention (e.g. a single reusable job that all workflows call) to keep the skip logic consistent and easier to update.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- These `if: "!contains(github.event.pull_request.title, '[citest_skip]')"` conditions will fail on non-`pull_request` events (e.g. `push`) where `github.event.pull_request` is undefined; consider guarding with `github.event_name == 'pull_request' && !contains(...)` or similar.
- Since the same `if` condition is duplicated across multiple workflow files, consider extracting this into a reusable workflow or a shared convention (e.g. a single reusable job that all workflows call) to keep the skip logic consistent and easier to update.

---

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

[Jakuje]

I am ok with this change, given the citest_skip will be used in times where we are sure its really not needed.
From the past I remember that given the CI runs only occasionally, the underlying images are changing, ansible is updated and new failures that need to be fiexed emerge even without changing the roles, that need to be fixed.

[richm]

I am ok with this change, given the citest_skip will be used in times where we are sure its really not needed. From the past I remember that given the CI runs only occasionally, the underlying images are changing, ansible is updated and new failures that need to be fiexed emerge even without changing the roles, that need to be fixed.

I will mostly use it for changelog updates for a new release, and things like updating versions of github actions, or other things which don't need to trigger test/check actions.

One of the reasons why I did this is because when I update all roles, and all of those jobs are started, I think we are being throttled by github, because the jobs stay queued for a long time, which unnecessarily delays releases.