Skip to content

ci: Pass in __bootc_validation as boolean, not string#191

Closed
richm wants to merge 1 commit into
mainfrom
bootc_validation_bool
Closed

ci: Pass in __bootc_validation as boolean, not string#191
richm wants to merge 1 commit into
mainfrom
bootc_validation_bool

Conversation

@richm

@richm richm commented Sep 5, 2025

Copy link
Copy Markdown
Contributor

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 local testing by passing __bootc_validation as a YAML boolean, bumping tox-lsr to version 3.11.1 in workflows, extending tft CITest retry logic to include cancelled runs, and adding local QEMU CI testing instructions.

Bug Fixes:

  • Pass __bootc_validation via --extra-vars as a YAML boolean instead of string
  • Extend tft_citest_bad workflow to treat cancelled runs as retryable failures

Enhancements:

  • Upgrade tox-lsr dependency from 3.11.0 to 3.11.1 across all CI workflows

CI:

  • Update boolean extra-vars syntax in qemu-kvm integration tests
  • Apply version bump and syntax fixes in ansible-lint, ansible-managed-var-comment, ansible-test, and python-unit-test workflows

Documentation:

  • Add a "Running CI Tests Locally" section to contributing.md with instructions for QEMU-based tox-lsr testing

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

sourcery-ai Bot commented Sep 5, 2025

Copy link
Copy Markdown

Reviewer's Guide

This PR refines CI behavior by enforcing a boolean type for __bootc_validation via YAML syntax, upgrades the tox-lsr dependency to v3.11.1 across multiple workflows, enhances the Terraform test runner to include cancelled runs, and enriches contributing.md with local CI test instructions.

Sequence diagram for improved Terraform test runner failure detection

sequenceDiagram
  participant "GitHub Actions Workflow"
  participant "gh CLI"
  participant "jq"
  participant "User"
  "User"->>"GitHub Actions Workflow": Trigger workflow
  "GitHub Actions Workflow"->>"gh CLI": Query workflow runs for tft.yml
  "gh CLI"->>"jq": Filter runs by display_title and conclusion
  "jq"->>"GitHub Actions Workflow": Return run ID if conclusion is "failure" or "cancelled"
  "GitHub Actions Workflow"->>"User": Notify if failed/cancelled workflow found or exit if not
Loading

File-Level Changes

Change Details Files
Pass __bootc_validation as a boolean YAML extra-var
  • Replace unquoted -e __bootc_validation=true with -e "__bootc_validation: true" in the qemu-kvm integration command
.github/workflows/qemu-kvm-integration-tests.yml
Bump tox-lsr to version 3.11.1 in CI workflows
  • Update pip install references from @3.11.0 to @3.11.1 in GitHub Action workflows
.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
Improve Terraform test failure detection
  • Add a comment explaining TF tests may cancel
  • Extend jq filter to include cancelled conclusions alongside failure
.github/workflows/tft_citest_bad.yml
Add local CI testing instructions to contributing.md
  • Append a 'Running CI Tests Locally' section with steps for setting up tox-lsr and qemu-based testing
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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

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 refactoring the repeated pip3 install "git+https://github.com/linux-system-roles/tox-lsr@3.11.1" lines across workflows into a reusable step or composite action to reduce duplication and simplify future version bumps.
  • The new ‘Running CI Tests Locally’ instructions are useful but might be better extracted into a dedicated docs/ci-testing.md (or similar) so that CONTRIBUTING.md stays focused on contribution guidelines.
  • This PR bundles boolean‐passing fixes, CI version bumps, and a big documentation addition—consider splitting unrelated changes into separate PRs to make reviews and rollbacks easier.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider refactoring the repeated `pip3 install "git+https://github.com/linux-system-roles/tox-lsr@3.11.1"` lines across workflows into a reusable step or composite action to reduce duplication and simplify future version bumps.
- The new ‘Running CI Tests Locally’ instructions are useful but might be better extracted into a dedicated `docs/ci-testing.md` (or similar) so that CONTRIBUTING.md stays focused on contribution guidelines.
- This PR bundles boolean‐passing fixes, CI version bumps, and a big documentation addition—consider splitting unrelated changes into separate PRs to make reviews and rollbacks easier.

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