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

* 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

sourcery-ai bot commented Sep 5, 2025

Reviewer's Guide

This PR standardizes and modernizes CI configurations by upgrading the GitHub checkout action, bumping tox-lsr to the latest patch, correcting boolean variable handling, extending failure detection for canceled runs, and enriching local CI test documentation.

Sequence diagram for improved failure/cancellation detection in tft_citest_bad workflow

sequenceDiagram
  participant "GitHub Actions"
  participant "gh CLI"
  participant "tft_citest_bad workflow"
  "tft_citest_bad workflow"->>"gh CLI": Query workflow runs for PR title
  "gh CLI"-->>"tft_citest_bad workflow": Return runs with conclusion "failure" or "cancelled"
  "tft_citest_bad workflow"->>"GitHub Actions": If run found, post bad comment
  "tft_citest_bad workflow"->>"GitHub Actions": If not found, exit
Loading

File-Level Changes

Change Details Files
Upgrade GitHub Actions checkout plugin to v5 across workflows
  • replaced all uses of 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/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 dependency to version 3.11.1
  • updated pip installs 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
.github/workflows/python-unit-test.yml
Ensure __bootc_validation is passed as a boolean
  • quoted the -e "__bootc_validation: true" extra-var to enforce YAML boolean parsing
.github/workflows/qemu-kvm-integration-tests.yml
Detect cancelled test runs in citest bad comment workflow
  • extended jq filter to include conclusion == "cancelled" in addition to failures
.github/workflows/tft_citest_bad.yml
Add local CI test instructions to contributing.md
  • introduced a new section outlining tox-lsr and qemu-based local testing setup steps
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

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

  • A lot of repetitive version bumps and checkout updates across workflows could be consolidated into a reusable workflow or a single variables file to simplify future maintenance.
  • The new "Running CI Tests Locally" section in contributing.md is quite lengthy—consider extracting it into its own guide and linking to it instead of embedding all details inline.
  • Verify that the change to quote __bootc_validation: true is consistently applied across all relevant workflows and update any documentation or examples accordingly.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- A lot of repetitive version bumps and checkout updates across workflows could be consolidated into a reusable workflow or a single variables file to simplify future maintenance.
- The new "Running CI Tests Locally" section in contributing.md is quite lengthy—consider extracting it into its own guide and linking to it instead of embedding all details inline.
- Verify that the change to quote `__bootc_validation: true` is consistently applied across all relevant workflows and update any documentation or examples accordingly.

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.

* 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>
* 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 merged commit 1667c1d into main Sep 5, 2025
22 of 26 checks passed
@richm richm deleted the bootc_validation_bool branch September 5, 2025 22:36
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