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 to multiple GitHub Actions workflows so that most CI jobs are skipped when a pull request title contains the marker string "[citest_skip]".

Flow diagram for CI job skipping based on PR title marker

flowchart LR
  A[Pull_request_created_or_updated] --> B[Read_pull_request_title]
  B --> C{Title_contains_citest_skip}
  C -- Yes --> D[Evaluate_job_if_condition_not_contains_citest_skip]
  D --> E[Job_is_skipped]
  C -- No --> F[Run_all_configured_CI_jobs]
  F --> G[Report_full_CI_results]
  E --> H[Report_reduced_CI_results]
Loading

File-Level Changes

Change Details Files
Conditionally skip specific GitHub Actions jobs based on PR title marker.
  • Add an 'if: "!contains(github.event.pull_request.title, '[citest_skip]')"' condition to each CI job so it only runs when the PR title does not include the citest_skip marker
  • Apply the conditional to linting, testing, spelling, markdown, integration tests, README conversion, and inclusive language workflows to minimize unnecessary CI usage for CI/docs-only changes
.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 left some high level feedback:

  • Relying on a magic substring in the PR title ([citest_skip]) can be brittle and easy to forget; consider using a dedicated label (e.g. ci:skip-heavy) and checking contains(github.event.pull_request.labels.*.name, 'ci:skip-heavy') instead for a more robust toggle.
  • These if conditions are duplicated across many workflows; consider extracting this into a reusable workflow or a shared convention (e.g. a single reusable should-run job returning an output) to avoid drift if the condition ever needs to change.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Relying on a magic substring in the PR title (`[citest_skip]`) can be brittle and easy to forget; consider using a dedicated label (e.g. `ci:skip-heavy`) and checking `contains(github.event.pull_request.labels.*.name, 'ci:skip-heavy')` instead for a more robust toggle.
- These `if` conditions are duplicated across many workflows; consider extracting this into a reusable workflow or a shared convention (e.g. a single reusable `should-run` job returning an output) to avoid drift if the condition ever needs to change.

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 <[email protected]>
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 <[email protected]>
@richm richm merged commit 499a04a into main Feb 4, 2026
11 checks passed
@richm richm deleted the citest_skip branch February 4, 2026 14:03
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