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.

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

Summary by Sourcery

Improve CI reliability and consistency by treating __bootc_validation as a boolean, extending failure detection to cancelled runs, upgrading checkout actions and tox-lsr versions, and enhancing documentation for local CI testing.

Bug Fixes:

  • Pass __bootc_validation as a YAML boolean instead of a string in qemu-kvm integration tests
  • Allow cancelled runs as failures in the tft_citest_bad workflow

Enhancements:

  • Upgrade actions/checkout from v4 to v5 across all GitHub CI workflows
  • Bump tox-lsr dependency to version 3.11.1 in various CI workflows

Documentation:

  • Add a ‘Running CI Tests Locally’ section to contributing.md with instructions for 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.

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 by updating local testing docs, modernizing GitHub Action workflows (checkout version bump, tox-lsr upgrade), passing the __bootc_validation flag as a YAML boolean, and refining the TF CITest failure logic.

File-Level Changes

Change Details Files
Add local CI testing instructions
  • Introduce a new 'Running CI Tests Locally' section
  • Detail steps for using tox-lsr with QEMU
  • Include prerequisites and example commands
contributing.md
Upgrade actions/checkout from v4 to v5 across workflows
  • Replace 'uses: actions/checkout@v4' with '@v5' in CI workflows
.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/python-unit-test.yml
.github/workflows/tft.yml
.github/workflows/changelog_to_tag.yml
.github/workflows/codeql.yml
.github/workflows/codespell.yml
.github/workflows/markdownlint.yml
.github/workflows/pr-title-lint.yml
.github/workflows/shellcheck.yml
.github/workflows/test_converting_readme.yml
.github/workflows/weekly_ci.yml
.github/workflows/woke.yml
Bump tox-lsr version to 3.11.1 in CI installs
  • Update pip3 install URL to reference '@3.11.1' instead of '@3.11.0'
  • Adjust pip install commands in Python unit tests
.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
Pass __bootc_validation as a YAML boolean
  • Change '-e __bootc_validation=true' to '-e "__bootc_validation: true"'
.github/workflows/qemu-kvm-integration-tests.yml
Refine TF CITest failure detection
  • Add a comment about TF tests possibly being canceled
  • Extend jq filter to include runs with conclusion 'cancelled'
.github/workflows/tft_citest_bad.yml

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:

  • This PR bundles the __bootc_validation boolean fix with broad CI workflow version bumps and docs additions—consider splitting into focused PRs to keep changes scoped and reviews simpler.
  • The new “Running CI Tests Locally” section is comprehensive but quite long—consider extracting it into a standalone reference doc and linking from contributing.md to avoid clutter.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- This PR bundles the __bootc_validation boolean fix with broad CI workflow version bumps and docs additions—consider splitting into focused PRs to keep changes scoped and reviews simpler.
- The new “Running CI Tests Locally” section is comprehensive but quite long—consider extracting it into a standalone reference doc and linking from contributing.md to avoid clutter.

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 closed this Sep 5, 2025
@richm richm deleted the bootc_validation_bool branch September 5, 2025 21:43
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