Skip to content

Conversation

@richm
Copy link
Contributor

@richm richm commented Feb 3, 2026

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.

@richm richm requested a review from spetrosi as a code owner February 3, 2026 23:12
@richm richm self-assigned this Feb 3, 2026
@sourcery-ai
Copy link

sourcery-ai bot commented Feb 3, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds a conditional guard to multiple GitHub Actions CI jobs so they are skipped when a pull request title contains the marker string "[citest_skip]".

Flow diagram for CI job guard based on PR title citest_skip marker

flowchart TD
  PR["Pull_request_opened_or_synchronized"]
  CheckTitle["Check PR title contains [citest_skip]"]
  RunJobs["Run guarded CI jobs"]
  SkipJobs["Skip guarded CI jobs"]

  PR --> CheckTitle
  CheckTitle -->|contains [citest_skip]| SkipJobs
  CheckTitle -->|does_not_contain [citest_skip]| RunJobs

  subgraph Guarded_CI_Jobs
    AL["Job ansible_lint\nif: !contains(github.event.pull_request.title, [citest_skip])"]
    AMVC["Job ansible_managed_var_comment\nif: !contains(github.event.pull_request.title, [citest_skip])"]
    CS["Job codespell\nif: !contains(github.event.pull_request.title, [citest_skip])"]
    MDL["Job markdownlint\nif: !contains(github.event.pull_request.title, [citest_skip])"]
    WOKE["Job woke\nif: !contains(github.event.pull_request.title, [citest_skip])"]
  end

  RunJobs --> AL
  RunJobs --> AMVC
  RunJobs --> CS
  RunJobs --> MDL
  RunJobs --> WOKE

  SkipJobs -.jobs_marked_as_skipped_in_GitHub_UI.-> Guarded_CI_Jobs
Loading

File-Level Changes

Change Details Files
Gate most GitHub Actions CI jobs on the absence of the "[citest_skip]" marker in the PR title.
  • Add an if expression at the job level to check !contains(github.event.pull_request.title, '[citest_skip]') for each affected workflow job
  • Ensure that when a PR title includes "[citest_skip]", the corresponding CI job does not run, effectively reducing load for CI-only or doc-only changes
  • Apply the same condition consistently across linting, testing, spell checking, markdown validation, 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/codespell.yml
.github/workflows/markdownlint.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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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.

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
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.

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@richm richm merged commit 141f494 into main Feb 4, 2026
11 checks passed
@richm richm deleted the citest_skip branch February 4, 2026 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant