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

Streamline and strengthen CI testing workflows by upgrading the tox-lsr dependency, improving boolean variable handling, extending failure detection, and enriching local test documentation

CI:

  • Bump tox-lsr from 3.11.0 to 3.11.1 across GitHub workflows
  • Quote __bootc_validation as a YAML boolean in the extra-vars option
  • Extend the tft_citest_bad workflow to treat cancelled runs as failures

Documentation:

  • Add detailed instructions to contributing.md for running CI tests locally with 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 refines CI testing by enforcing a YAML boolean for bootc validation, upgrading tox-lsr to 3.11.1 across workflows, enhancing TF test cancellation detection in the citest bad comment workflow, and expanding CONTRIBUTING.md with detailed local CI testing instructions.

Sequence diagram for enhanced TF test cancellation detection in citest bad comment workflow

sequenceDiagram
  participant "GitHub Actions Workflow"
  participant "TF Testing Farm API"
  participant "User"

  "GitHub Actions Workflow"->>"TF Testing Farm API": Query workflow runs for PR
  "TF Testing Farm API"-->>"GitHub Actions Workflow": Return runs with conclusion (failure or cancelled)
  alt Run found (failure or cancelled)
    "GitHub Actions Workflow"->>"User": Post bad comment for failed/cancelled test
  else No run found
    "GitHub Actions Workflow"->>"User": Notify workflow not found
  end
Loading

File-Level Changes

Change Details Files
Pass YAML boolean for __bootc_validation via extra-vars
  • Changed -e __bootc_validation=true to -e "__bootc_validation: true" to ensure proper boolean handling
.github/workflows/qemu-kvm-integration-tests.yml
Upgrade tox-lsr to version 3.11.1 in CI workflows
  • Updated pip install URL from @3.11.0 to @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
Extend cancellation handling in citest bad comment workflow
  • Modified jq filter to include conclusion == "cancelled" alongside failures
  • Added comment noting TF tests may be cancelled due to internal issues
.github/workflows/tft_citest_bad.yml
Enrich CONTRIBUTING.md with local CI testing guide
  • Added "Running CI Tests Locally" section detailing qemu inventory script installation, tox and tox-lsr setup, and example 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:

  • Consider centralizing the tox-lsr version across all workflows (for example via a reusable action or variable) to avoid manually updating each file when bumping versions.
  • The extended qemu testing instructions in contributing.md could be moved to a dedicated guide or linked upstream to keep the main contributing doc concise and easier to maintain.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider centralizing the tox-lsr version across all workflows (for example via a reusable action or variable) to avoid manually updating each file when bumping versions.
- The extended qemu testing instructions in contributing.md could be moved to a dedicated guide or linked upstream to keep the main contributing doc concise and easier to maintain.

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 29cf596 into main Sep 5, 2025
20 checks passed
@richm richm deleted the bootc_validation_bool branch September 5, 2025 22:06
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