Skip to content

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

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]#253
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 running Ansible linting and tests.

CI:

  • Bump tox-lsr version to 3.18.1 across all GitHub Actions workflows.
  • Split ansible-lint and ansible-test workflows into separate steps for converting the role to a collection and running the respective checks, 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 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 so the collection build step is separated from the lint/test execution, aligning with new dependency-installation requirements.

Flow diagram for separated collection build and ansible-lint steps

flowchart TD
  Trigger[Push or Pull Request] --> Job_start[Start ansible-lint job]

  Job_start --> Install_tox_lsr[Install tox and tox-lsr 3.18.1]
  Install_tox_lsr --> Setup_python[Set up Python matrix version]

  Setup_python --> Build_collection[Run tox -e collection to convert role to collection]
  Build_collection --> Run_ansible_lint[Run tox -e ansible-lint-collection]

  Run_ansible_lint --> CI_pass[Job succeeds]
  Run_ansible_lint --> CI_fail[Job fails]
Loading

File-Level Changes

Change Details Files
Bump tox-lsr to version 3.18.1 across all GitHub Actions workflows so that collection dependencies are installed correctly.
  • Update pip installation of tox-lsr from 3.18.0 to 3.18.1 in ansible-lint workflow.
  • Update pip installation of tox-lsr from 3.18.0 to 3.18.1 in ansible-test workflow.
  • Update pip installation of tox-lsr from 3.18.0 to 3.18.1 in ansible-managed-var-comment workflow.
  • Update pip installation of tox-lsr from 3.18.0 to 3.18.1 in python-unit-test workflow.
  • Update pip installation of tox-lsr from 3.18.0 to 3.18.1 in qemu-kvm-integration-tests workflow.
.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 and ansible-test CI jobs to separate the collection build step from linting/testing, using dedicated tox environments.
  • Split the ansible-lint workflow step into a collection conversion step running tox -e collection and a separate ansible-lint step running only the ansible-lint tox environment with appropriate environment variables and basepython override.
  • Split the ansible-test workflow step into a collection conversion step running tox -e collection and a separate ansible-test step running only the ansible-test tox environment with the correct basepython override, dropping collection from the env list.
.github/workflows/ansible-lint.yml
.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:

  • The tox-lsr version string is duplicated across multiple workflows; consider centralizing it via a workflow-level env var or a shared reusable workflow to simplify future upgrades.
  • Now that tox -e collection is a separate step in both ansible-lint and ansible-test workflows, consider factoring that into a shared job or composite action to reduce duplication and keep the collection-building logic consistent.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The tox-lsr version string is duplicated across multiple workflows; consider centralizing it via a workflow-level env var or a shared reusable workflow to simplify future upgrades.
- Now that `tox -e collection` is a separate step in both ansible-lint and ansible-test workflows, consider factoring that into a shared job or composite action to reduce duplication and keep the collection-building logic consistent.

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