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:13
@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

This PR updates multiple GitHub Actions workflows so that their jobs are skipped when a pull request title contains the marker "[citest_skip]", allowing CI-heavy checks to be bypassed for certain maintenance PRs.

Sequence diagram for conditional CI job execution based on PR title

sequenceDiagram
  actor Developer
  participant GitHub
  participant Workflow_ansible_lint
  participant Workflow_codespell
  participant Workflow_markdownlint
  participant Workflow_woke

  Developer->>GitHub: Open_pull_request_with_title
  GitHub-->>Workflow_ansible_lint: pull_request_event
  GitHub-->>Workflow_codespell: pull_request_event
  GitHub-->>Workflow_markdownlint: pull_request_event
  GitHub-->>Workflow_woke: pull_request_event

  alt Title_contains_citest_skip
    Workflow_ansible_lint-->>Workflow_ansible_lint: if !contains(title,'[citest_skip]') is false
    Workflow_codespell-->>Workflow_codespell: Job_skipped
    Workflow_markdownlint-->>Workflow_markdownlint: Job_skipped
    Workflow_woke-->>Workflow_woke: Job_skipped
  else Title_does_not_contain_citest_skip
    Workflow_ansible_lint->>Workflow_ansible_lint: Run_ansible_lint_steps
    Workflow_codespell->>Workflow_codespell: Run_codespell_steps
    Workflow_markdownlint->>Workflow_markdownlint: Run_markdownlint_steps
    Workflow_woke->>Workflow_woke: Run_woke_steps
  end

  GitHub-->>Developer: Report_status_with_jobs_run_or_skipped
Loading

File-Level Changes

Change Details Files
Conditionally skip ansible-lint, ansible-test, and related CI jobs based on PR title marker
  • Add an if condition to the ansible-lint job to skip when the PR title contains "[citest_skip]"
  • Add an if condition to the ansible_managed_var_comment job to skip when the PR title contains "[citest_skip]"
  • Add an if condition to the ansible_test job to skip when the PR title contains "[citest_skip]"
  • Add an if condition to the codespell job to skip when the PR title contains "[citest_skip]"
  • Add an if condition to the markdownlint job to skip when the PR title contains "[citest_skip]"
  • Add an if condition to the qemu-kvm integration test scenario job to skip when the PR title contains "[citest_skip]"
  • Add an if condition to the test_converting_readme job to skip when the PR title contains "[citest_skip]"
  • Add an if condition to the woke job to skip when the PR title contains "[citest_skip]"
.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:

  • These workflows assume github.event.pull_request is always present; if any of them are ever triggered by non-pull_request events (e.g., push), consider guarding the condition with github.event_name == 'pull_request' or github.event.pull_request && !contains(...) to avoid null access issues.
  • Using the PR title as the control surface for skipping CI can be brittle (e.g., title edits, typos); you might consider using a dedicated label (checked via github.event.pull_request.labels) instead, which is easier to manage and script.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- These workflows assume `github.event.pull_request` is always present; if any of them are ever triggered by non-`pull_request` events (e.g., `push`), consider guarding the condition with `github.event_name == 'pull_request'` or `github.event.pull_request && !contains(...)` to avoid null access issues.
- Using the PR title as the control surface for skipping CI can be brittle (e.g., title edits, typos); you might consider using a dedicated label (checked via `github.event.pull_request.labels`) instead, which is easier to manage and script.

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

2 participants