Skip to content

ci: rollout several recent changes to CI testing#261

Merged
richm merged 1 commit intomainfrom
bootc_validation_bool
Sep 5, 2025
Merged

ci: rollout several recent changes to CI testing#261
richm merged 1 commit intomainfrom
bootc_validation_bool

Conversation

@richm
Copy link
Copy Markdown
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

Roll out recent CI changes by upgrading tox-lsr, refining test invocation flags, improving failure detection, and expanding local CI documentation.

CI:

  • Upgrade tox-lsr to version 3.11.1 across all GitHub workflows
  • Pass __bootc_validation as a YAML boolean in tox commands
  • Allow the tft_citest_bad workflow to detect cancelled runs in addition to failures

Documentation:

  • Add a 'Running CI Tests Locally' section to contributing.md with qemu testing steps and tox-lsr setup

* 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 requested a review from natoscott as a code owner September 5, 2025 21:52
@richm richm self-assigned this Sep 5, 2025
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented Sep 5, 2025

Reviewer's Guide

This PR enhances CI testing by enforcing YAML boolean handling for __bootc_validation, upgrading tox-lsr to v3.11.1 across workflows, improving TF bad-test detection to include cancellations, and expanding local CI run documentation.

Sequence diagram for improved TF bad-test detection (failure or cancelled)

sequenceDiagram
  participant Workflow
  participant GitHub API
  participant jq
  Workflow->>GitHub API: Request workflow runs for PR
  GitHub API-->>Workflow: Return workflow runs
  Workflow->>jq: Filter runs by display_title and conclusion ("failure" or "cancelled")
  jq-->>Workflow: Return RUN_ID
  Workflow->>Workflow: If RUN_ID is null, exit with error
Loading

File-Level Changes

Change Details Files
Force __bootc_validation to be treated as a YAML boolean
  • Quote the extra-vars option as a YAML mapping
  • Replace -e __bootc_validation=true with -e "__bootc_validation: true"
.github/workflows/qemu-kvm-integration-tests.yml
Bump tox-lsr dependency to version 3.11.1
  • Update pip install URIs in CI workflows to reference v3.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
Expand TF bad-test detection to include cancelled runs
  • Amend jq filter to match workflows with conclusion "failure" or "cancelled"
  • Add comment explaining cancellation handling
.github/workflows/tft_citest_bad.yml
Enhance local CI testing documentation
  • Add a new section on using tox-lsr with QEMU
  • Detail setup steps and prerequisites for local CI runs
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
Copy Markdown

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

  • Repeatedly bumping the tox-lsr version in each workflow is error-prone; consider centralizing that version in a shared variable or matrix to simplify future updates.
  • The new "Running CI Tests Locally" section is quite detailed—consider moving it into a dedicated CI guide or condensing it to keep contributing.md focused on high-level instructions.
  • Since you’re now quoting the YAML boolean for __bootc_validation, add a brief note explaining why the quotes are necessary to prevent regressions or confusion later.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Repeatedly bumping the tox-lsr version in each workflow is error-prone; consider centralizing that version in a shared variable or matrix to simplify future updates.
- The new "Running CI Tests Locally" section is quite detailed—consider moving it into a dedicated CI guide or condensing it to keep contributing.md focused on high-level instructions.
- Since you’re now quoting the YAML boolean for __bootc_validation, add a brief note explaining why the quotes are necessary to prevent regressions or confusion 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.

@richm richm merged commit ffb05e6 into main Sep 5, 2025
15 of 20 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.

1 participant