Skip to content

ci: ansible-lint requires dependencies to be installed [citest_skip]#204

Merged
richm merged 1 commit intomainfrom
ci-ansible-lint-install-deps
Apr 9, 2026
Merged

ci: ansible-lint requires dependencies to be installed [citest_skip]#204
richm merged 1 commit intomainfrom
ci-ansible-lint-install-deps

Conversation

@richm
Copy link
Copy Markdown
Contributor

@richm richm commented Apr 9, 2026

ansible-lint requires the dependencies in meta/collection-requirements.yml
and tests/collection-requirements.yml to be installed. tox-lsr 3.18.1
will ensure they are installed.

Refactor the tests somewhat so that the collection and test steps are separate.

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

Summary by Sourcery

Update CI workflows to use the latest tox-lsr release and separate collection conversion from ansible lint/test execution.

CI:

  • Bump tox-lsr used in GitHub Actions workflows from 3.18.0 to 3.18.1.
  • Split ansible-lint and ansible-test workflows into distinct steps for collection conversion and running the respective tools, adjusting tox environments accordingly.

ansible-lint requires the dependencies in meta/collection-requirements.yml
and tests/collection-requirements.yml to be installed.  tox-lsr 3.18.1
will ensure they are installed.

Refactor the tests somewhat so that the collection and test steps are separate.

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@richm richm requested a review from spetrosi as a code owner April 9, 2026 23:00
@richm richm self-assigned this Apr 9, 2026
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented Apr 9, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates CI workflows to use tox-lsr 3.18.1 and refactors ansible-lint and ansible-test jobs to separate the collection conversion step from the lint/test execution, aligning with new dependency handling requirements.

Flow diagram for refactored ansible_lint workflow steps

flowchart TD
  Start["Start ansible-lint job"] --> Checkout["Checkout repository"]
  Checkout --> InstallToxLsr["pip install tox-lsr 3.18.1"]
  InstallToxLsr --> SetupPython["Set up Python (matrix python-version)"]

  SetupPython --> ConvertToCollection["tox -e collection (convert role to collection format)"]

  ConvertToCollection --> RunAnsibleLint["Run tox -e ansible-lint-collection with
LSR_ANSIBLE_LINT_DEP=ansible-lint==matrix.ansible_lint
LSR_ANSIBLE_LINT_ANSIBLE_DEP=ansible-core==matrix.ansible"]

  RunAnsibleLint --> End["Job finished"]
Loading

File-Level Changes

Change Details Files
Upgrade tox-lsr to version 3.18.1 across all GitHub Actions workflows that use it.
  • Bump tox-lsr version from 3.18.0 to 3.18.1 in all workflow pip install commands
  • Ensure both pip and pip3 install invocations reference the new version consistently
.github/workflows/ansible-lint.yml
.github/workflows/ansible-test.yml
.github/workflows/ansible-managed-var-comment.yml
.github/workflows/python-unit-test.yml
.github/workflows/qemu-kvm-integration-tests.yml
Refactor ansible-lint GitHub workflow to decouple collection conversion from ansible-lint execution.
  • Split the combined job step into a dedicated 'Convert role to collection format' step running 'tox -e collection'
  • Adjust ansible-lint step to only run the ansible-lint tox environment and drop 'collection' from its -e argument list while preserving environment variable overrides for ansible-lint and ansible-core
.github/workflows/ansible-lint.yml
Refactor ansible-test GitHub workflow to run collection conversion separately from ansible-test execution.
  • Add a separate 'Convert role to collection format' step running 'tox -e collection' before tests
  • Update the ansible-test step to only run the ansible-test tox environment and remove 'collection' from the -e argument list while keeping the basepython override
.github/workflows/ansible-test.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
Copy Markdown

@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 - I've left some high level feedback:

  • Consider extracting the tox-lsr version into a single reusable location (e.g., a workflow env var or .github/workflows reusable workflow) so future version bumps don’t require editing multiple files.
  • Now that collection conversion and test/lint steps are separate jobs, it may be worth adding a short comment in the workflows explaining why they must run in this order to avoid future accidental re-merging.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider extracting the `tox-lsr` version into a single reusable location (e.g., a workflow env var or `.github/workflows` reusable workflow) so future version bumps don’t require editing multiple files.
- Now that collection conversion and test/lint steps are separate jobs, it may be worth adding a short comment in the workflows explaining why they must run in this order to avoid future accidental re-merging.

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 8b50fa6 into main Apr 9, 2026
13 checks passed
@richm richm deleted the ci-ansible-lint-install-deps branch April 9, 2026 23:16
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