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

Update CI workflows to use the latest GitHub Action and tox-lsr versions, enforce boolean handling for validation flags, and improve CI test reliability.

Bug Fixes:

  • recognize cancelled test runs as failures in the citest bad comment workflow

Enhancements:

  • upgrade actions/checkout to v5 across all workflows
  • update tox-lsr dependency to version 3.11.1 in CI scripts
  • pass __bootc_validation as a YAML boolean in QEMU integration tests

Documentation:

  • add instructions for running CI tests locally to contributing.md

* 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
Contributor

sourcery-ai bot commented Sep 5, 2025

Reviewer's Guide

This PR standardizes and enhances CI pipelines by upgrading core dependencies and GitHub Actions versions, refining test invocation flags, improving cancellation handling, and adding local CI testing documentation.

Flow diagram for improved test cancellation handling in tft_citest_bad.yml

flowchart TD
  A["Check if workflow is still running"] --> B["If running, exit"]
  B --> C["If not running, check for failed or cancelled runs"]
  C --> D["If found, get RUN_ID"]
  D --> E["If not found, exit"]
Loading

File-Level Changes

Change Details Files
Bump GitHub Actions checkout to v5 across workflows
  • Replace actions/checkout@v4 with actions/checkout@v5
.github/workflows/build_docs.yml
.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/tft.yml
.github/workflows/changelog_to_tag.yml
.github/workflows/codespell.yml
.github/workflows/markdownlint.yml
.github/workflows/pr-title-lint.yml
.github/workflows/test_converting_readme.yml
.github/workflows/weekly_ci.yml
.github/workflows/woke.yml
Upgrade tox-lsr to version 3.11.1 in CI jobs
  • Update pip install of tox-lsr 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
Pass __bootc_validation as a YAML boolean
  • Change extra-vars flag from -e __bootc_validation=true to -e "__bootc_validation: true"
.github/workflows/qemu-kvm-integration-tests.yml
Extend citest bad comment logic to cancelled runs
  • Include runs with conclusion 'cancelled' in failure detection
.github/workflows/tft_citest_bad.yml
Add local CI testing instructions
  • Introduce a 'Running CI Tests Locally' section with steps for qemu and tox-lsr setup
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
Contributor

@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 pip3 install of tox-lsr@3.11.1 across multiple workflows would be easier to maintain if you extracted the version into a single reusable variable or a composite step.
  • You’ve added a sizable CI-testing guide to contributing.md—consider splitting this into its own PR or a separate docs file to keep the CI rollout focused and easier to review.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The repeated pip3 install of tox-lsr@3.11.1 across multiple workflows would be easier to maintain if you extracted the version into a single reusable variable or a composite step.
- You’ve added a sizable CI-testing guide to contributing.md—consider splitting this into its own PR or a separate docs file to keep the CI rollout focused and easier to review.

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 da58adf into main Sep 5, 2025
17 of 19 checks passed
@richm richm deleted the bootc_validation_bool branch September 5, 2025 22:15
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