Skip to content

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

Closed
richm wants to merge 1 commit intomainfrom
bootc_validation_bool
Closed

ci: Pass in __bootc_validation as boolean, not string#248
richm wants to merge 1 commit intomainfrom
bootc_validation_bool

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 configurations and documentation across workflows

New Features:

  • Add instructions for running CI tests locally with tox-lsr and QEMU to contributing.md

Bug Fixes:

  • Pass __bootc_validation as a YAML boolean to ensure proper type in CI runs
  • Include cancelled workflow runs alongside failures in tft_citest_bad filter

Enhancements:

  • Upgrade actions/checkout usage from v4 to v5 across all GitHub workflow files
  • Bump tox-lsr installation version from 3.11.0 to 3.11.1 in relevant CI workflows

Documentation:

  • Document local CI test setup in 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.

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 adjusts CI configurations so that the __bootc_validation extra var is passed as a YAML boolean, updates workflow actions to v5, upgrades the tox-lsr dependency, enhances the TF CI rerun logic, and adds a new “Running CI Tests Locally” section to contributing.md.

Flow diagram for passing __bootc_validation as YAML boolean in CI

flowchart TD
  A["CI Workflow"] --> B["Pass extra-vars to Ansible"]
  B --> C["__bootc_validation: true (YAML boolean)"]
  C --> D["Ansible interprets as boolean"]
Loading

Flow diagram for enhanced TF CI rerun logic

flowchart TD
  A["TF CI rerun script"] --> B["Query workflow runs with gh api"]
  B --> C["Filter runs by display_title == PR_TITLE"]
  C --> D["Select runs with conclusion == failure or cancelled"]
  D --> E["Get RUN_ID for rerun"]
Loading

File-Level Changes

Change Details Files
Add instructions for running CI tests locally with tox-lsr and QEMU
  • Append a new “Running CI Tests Locally” section with step-by-step guidance for qemu testing
  • Detail prerequisites, installation commands, and example tox invocation
contributing.md
Standardize GitHub Actions checkout to v5 across workflows
  • Replace actions/checkout@v4 with @v5 in all workflow files
.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/tft_citest_bad.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 dependency version in CI pipelines
  • Bump pip3 install invocation from tox-lsr@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 instead of string
  • Change -e __bootc_validation=true to -e "__bootc_validation: true" in tox invocation
.github/workflows/qemu-kvm-integration-tests.yml
Enhance TF CI rerun logic to include cancelled runs
  • Update jq filter to select runs with conclusion == 'failure' or 'cancelled'
  • Add comment explaining why cancelled runs should be treated similarly
.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
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:

  • Consider splitting the large docs and workflow version bumps into separate commits or PRs so that the actual __bootc_validation boolean change stays isolated and easier to review.
  • Since you updated tox-lsr from 3.11.0 to 3.11.1 across multiple workflows, consider centralizing that version in a shared matrix or variable to prevent future drift.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider splitting the large docs and workflow version bumps into separate commits or PRs so that the actual `__bootc_validation` boolean change stays isolated and easier to review.
- Since you updated tox-lsr from 3.11.0 to 3.11.1 across multiple workflows, consider centralizing that version in a shared matrix or variable to prevent future drift.

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.

1 participant

Comments