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

Configures multiple GitHub Actions CI jobs to be conditionally skipped when a pull request title contains the marker '[citest_skip]', allowing CI to be bypassed for certain PRs such as CI or docs-only changes.

Sequence diagram for conditional CI job execution based on citest_skip

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: Trigger ansible_lint on pull_request
  GitHub-->>Workflow_codespell: Trigger codespell on pull_request
  GitHub-->>Workflow_markdownlint: Trigger markdownlint on pull_request
  GitHub-->>Workflow_woke: Trigger woke on pull_request

  alt Title contains [citest_skip]
    Workflow_ansible_lint-->>GitHub: Job skipped by if condition
    Workflow_codespell-->>GitHub: Job skipped by if condition
    Workflow_markdownlint-->>GitHub: Job skipped by if condition
    Workflow_woke-->>GitHub: Job skipped by if condition
  else Title does not contain [citest_skip]
    Workflow_ansible_lint->>Workflow_ansible_lint: Run CI steps
    Workflow_codespell->>Workflow_codespell: Run CI steps
    Workflow_markdownlint->>Workflow_markdownlint: Run CI steps
    Workflow_woke->>Workflow_woke: Run CI steps
  end
Loading

File-Level Changes

Change Details Files
Gate all main CI-related GitHub Actions jobs on a PR title marker so they don’t run when the title contains '[citest_skip]'.
  • Added an if: "!contains(github.event.pull_request.title, '[citest_skip]')" condition to the ansible-lint job.
  • Added the same if condition to the ansible-managed-var-comment job.
  • Added the same if condition to the ansible-test job.
  • Added the same if condition to the codespell job.
  • Added the same if condition to the markdownlint job.
  • Added the same if condition to the qemu-kvm integration tests job.
  • Added the same if condition to the test_converting_readme job.
  • Added the same if condition to the woke job.
.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:

  • If any of these workflows are also triggered by events other than pull_request (e.g. push), consider guarding the condition with the event type (e.g. if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')) to avoid referencing a non-existent pull_request payload.
  • Since the [citest_skip] marker is now used across multiple workflows, you may want to define a single reusable expression (e.g. via a reusable workflow or shared env/jobs.<job>.if pattern) to keep this logic consistent and easier to update later.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- If any of these workflows are also triggered by events other than `pull_request` (e.g. `push`), consider guarding the condition with the event type (e.g. `if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')`) to avoid referencing a non-existent `pull_request` payload.
- Since the `[citest_skip]` marker is now used across multiple workflows, you may want to define a single reusable expression (e.g. via a reusable workflow or shared `env`/`jobs.<job>.if` pattern) to keep this logic consistent and easier to update later.

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 ebb6072 into main Feb 4, 2026
11 checks passed
@richm richm deleted the citest_skip branch February 4, 2026 13:46
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