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 mechanism to skip most CI jobs when a pull request title contains the marker "[citest_skip]", adjusts a tft test plan filter, and changes the weekly CI trigger time.

Flow diagram for CI job execution decision based on PR title marker

graph TD
  A["GitHub receives pull_request event"] --> B["Read github.event.pull_request.title"]
  B --> C{"Title contains<br>[citest_skip]?"}
  C -- Yes --> D["Condition !contains(title,[citest_skip]) is false"]
  D --> E["Skip conditional CI jobs<br>(ansible_lint, ansible_managed_var_comment, codespell, markdownlint, woke)"]
  C -- No --> F["Condition !contains(title,[citest_skip]) is true"]
  F --> G["Run all CI jobs<br>including ansible_lint, ansible_managed_var_comment, codespell, markdownlint, woke"]

Loading

File-Level Changes

Change	Details	Files
Allow selectively skipping CI jobs based on a PR title marker	Add a job-level if condition to multiple workflows to skip execution when the pull request title contains the string "[citest_skip]" Apply the conditional to linting, testing, spelling, markdown, qemu integration, README conversion, and inclusive-language jobs	.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/test_converting_readme.yml .github/workflows/woke.yml
Adjust tft workflow plan filter and weekly CI schedule	Change the tft workflow tmt_plan_filter value from "tag:playbooks_parallel,template" to "tag:playbooks_parallel,cvm_deploy" to target a different test plan subset Update the weekly CI cron from 0 0 * * 6 to 0 23 * * 6, shifting the scheduled run time	.github/workflows/tft.yml .github/workflows/weekly_ci.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:

• Using github.event.pull_request.title in job-level if conditions will fail for any workflow that can be triggered by non-pull_request events; consider guarding the access (e.g. if: github.event_name == 'pull_request' && !contains(github.event.pull_request.title, '[citest_skip]')) or otherwise ensuring those workflows only ever run on pull_request.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Using `github.event.pull_request.title` in job-level `if` conditions will fail for any workflow that can be triggered by non-`pull_request` events; consider guarding the access (e.g. `if: github.event_name == 'pull_request' && !contains(github.event.pull_request.title, '[citest_skip]')`) or otherwise ensuring those workflows only ever run on `pull_request`.

---

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