Skip to content

Conversation

@richm
Copy link
Contributor

@richm richm commented Sep 5, 2025

  • Pass in a YAML true value as __bootc_validation: true using
    the --extra-vars option to ensure that __bootc_validation is
    treated as a boolean and not a string value.

-e "__bootc_validation: true"

You can also use JSON format:

-e '{"__bootc_validation": true}'

but YAML is simpler in this case.

  • Use tox-lsr version 3.11.1

  • Ensure the citest bad comment works when the test was cancelled in
    addition to the failure case.

  • Update contributing.md documentation

  • Update number of nodes to use in testing farm, if needed

  • remove unnecessary ansible-lint skips

Signed-off-by: Rich Megginson rmeggins@redhat.com

Summary by Sourcery

Roll out several recent updates to the CI testing workflows and documentation.

CI:

  • Bump tox-lsr dependency version to 3.11.1 across all GitHub workflow configurations.
  • Pass __bootc_validation as a YAML boolean (--extra-vars "__bootc_validation: true") in qemu-kvm integration tests.
  • Include cancelled runs alongside failures in the citest bad workflow filter.

Documentation:

  • Add a new section to contributing.md with step-by-step instructions for running CI tests locally using tox-lsr and QEMU.

* Pass in a YAML true value as `__bootc_validation: true` using
the --extra-vars option to ensure that `__bootc_validation` is
treated as a boolean and not a string value.

`-e "__bootc_validation: true"`

You can also use JSON format:

`-e '{"__bootc_validation": true}'`

but YAML is simpler in this case.

* Use tox-lsr version 3.11.1

* Ensure the citest bad comment works when the test was cancelled in
addition to the failure case.

* Update contributing.md documentation

* Update number of nodes to use in testing farm, if needed

* remove unnecessary ansible-lint skips

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@richm richm self-assigned this Sep 5, 2025
@sourcery-ai
Copy link

sourcery-ai bot commented Sep 5, 2025

Reviewer's Guide

This PR enhances CI workflows by passing the validation flag as a YAML boolean, upgrading tox-lsr to 3.11.1 across multiple jobs, extending the citest bad job to catch cancelled runs, and enriching contributing.md with local CI testing guidance.

Flow diagram for citest bad job handling cancelled and failed runs

flowchart TD
  A["Trigger citest bad job"] --> B["Check workflow status"]
  B --> C["Is workflow still running?"]
  C -- Yes --> D["Wait for completion"]
  C -- No --> E["Check for failure or cancelled conclusion"]
  E -- Found --> F["Get RUN_ID and proceed"]
  E -- Not found --> G["Exit with error"]
Loading

File-Level Changes

Change Details Files
Treat __bootc_validation as a YAML boolean
  • Replaced -e __bootc_validation=true with -e "__bootc_validation: true"
.github/workflows/qemu-kvm-integration-tests.yml
Bump tox-lsr to version 3.11.1
  • Updated pip install commands to reference @3.11.1
.github/workflows/qemu-kvm-integration-tests.yml
.github/workflows/ansible-lint.yml
.github/workflows/ansible-managed-var-comment.yml
.github/workflows/ansible-test.yml
.github/workflows/python-unit-test.yml
Support cancelled runs in citest bad job
  • Adjusted jq filter to include .conclusion == "cancelled"
  • Added comment noting tests may be cancelled due to TF issues
.github/workflows/tft_citest_bad.yml
Expand contributing.md with local CI testing instructions
  • Added 'Running CI Tests Locally' section
  • Outlined steps for installing and using tox-lsr with QEMU
  • Provided guidance on inventory script, config file, and test commands
contributing.md

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 there - I've reviewed your changes - here's some feedback:

  • The repeated pip install of tox-lsr@3.11.1 across multiple workflows could be consolidated into a reusable action or shared variable to avoid version drift.
  • The new "Running CI Tests Locally" section in contributing.md is quite detailed—consider moving it into its own guide or separate file to keep the main document concise and focused.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The repeated pip install of tox-lsr@3.11.1 across multiple workflows could be consolidated into a reusable action or shared variable to avoid version drift.
- The new "Running CI Tests Locally" section in contributing.md is quite detailed—consider moving it into its own guide or separate file to keep the main document concise and focused.

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.

@richm richm merged commit 67c9bf9 into main Sep 5, 2025
26 checks passed
@richm richm deleted the bootc_validation_bool branch September 5, 2025 22:12
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