Skip to content

Conversation

@richm
Copy link
Collaborator

@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

Apply recent CI testing updates across workflows and docs

Bug Fixes:

  • Extend the citest bad comment workflow to recognize cancelled runs as failures

CI:

  • Bump tox-lsr dependency to version 3.11.1 in multiple GitHub Actions workflows
  • Quote the __bootc_validation extra-var as YAML true to enforce boolean handling in qemu integration tests

Documentation:

  • Add a "Running CI Tests Locally" section to contributing.md with tox-lsr and qemu instructions

* 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 the CI setup by enforcing proper boolean handling for bootc validation, upgrading tox-lsr across workflows, improving test cancellation handling, and expanding local CI testing documentation.

Flow diagram for improved test cancellation handling in tft_citest_bad.yml

flowchart TD
  A["Check if workflow $PENDING_RUN is still running"] --> B["If running, exit"]
  B -->|No| C["Query TF workflow runs for PR title"]
  C --> D["Select runs with conclusion 'failure' or 'cancelled'"]
  D --> E["Get RUN_ID"]
  E --> F["If RUN_ID is null, exit"]
  F -->|Else| G["Continue with citest bad comment"]
Loading

File-Level Changes

Change Details Files
Pass YAML boolean for __bootc_validation in qemu integration
  • 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 pip3/pip install commands to reference tox-lsr@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
Handle cancelled runs in citest bad workflow
  • Expanded jq filter to include conclusion == "cancelled" alongside failure
.github/workflows/tft_citest_bad.yml
Add local CI test instructions to contributing.md
  • Inserted a “Running CI Tests Locally” section with steps for qemu setup, tox-lsr installation, config file download, and example invocation
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:

  • Consider centralizing the tox-lsr version in a single shared variable or matrix to avoid updating it in every workflow file.
  • The new “Running CI Tests Locally” section in CONTRIBUTING.md is quite detailed—consider moving it into a standalone guide or linking upstream to keep the CONTRIBUTING.md concise.
  • In tft_citest_bad.yml you now check for cancelled runs; if there are other non-success states you care about (e.g. timed_out), you may want to include them as well.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider centralizing the tox-lsr version in a single shared variable or matrix to avoid updating it in every workflow file.
- The new “Running CI Tests Locally” section in CONTRIBUTING.md is quite detailed—consider moving it into a standalone guide or linking upstream to keep the CONTRIBUTING.md concise.
- In tft_citest_bad.yml you now check for cancelled runs; if there are other non-success states you care about (e.g. timed_out), you may want to include them as well.

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 7484e14 into main Sep 5, 2025
25 of 27 checks passed
@richm richm deleted the bootc_validation_bool branch September 5, 2025 22:14
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