Skip to content

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

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]#860
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 and separate collection conversion from linting and testing steps.

CI:

  • Bump tox-lsr version 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 for running the respective tools.

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 workflows so that collection conversion and test execution run as separate tox environments, ensuring required collection dependencies are installed before linting and testing.

Flow diagram for separated collection and ansible-lint tox environments

flowchart TD
  start["Start ansible-lint job"] --> setup_python["Set up Python via actions/setup-python"]

  setup_python --> install_tox_lsr["pip install tox-lsr 3.18.1"]

  install_tox_lsr --> collection_env["Run tox -e collection"]

  collection_env --> check_collection_convert["Convert role to collection layout"]
  collection_env --> install_collection_requirements["Install dependencies from meta/collection-requirements.yml"]
  collection_env --> install_test_collection_requirements["Install dependencies from tests/collection-requirements.yml"]

  check_collection_convert --> ready_for_lint["Collection environment ready"]
  install_collection_requirements --> ready_for_lint
  install_test_collection_requirements --> ready_for_lint

  ready_for_lint --> lint_env["Run tox -e ansible-lint-collection"]

  lint_env --> run_ansible_lint["Run ansible-lint with specified ansible-core and ansible-lint versions"]

  run_ansible_lint --> job_end["Job completes"]
Loading

File-Level Changes

Change Details Files
Bump tox-lsr dependency from 3.18.0 to 3.18.1 across CI workflows.
  • Update pip installation of tox-lsr in ansible-lint workflow to use version 3.18.1
  • Update pip installation of tox-lsr in ansible-test workflow to use version 3.18.1
  • Update pip installation of tox-lsr in ansible-managed-var-comment workflow to use version 3.18.1
  • Update pip installation of tox-lsr in python-unit-test workflow to use version 3.18.1
  • Update pip installation of tox-lsr in qemu-kvm-integration-tests workflow to use version 3.18.1
.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 workflow to separate collection build from lint execution and adjust tox invocation accordingly.
  • Split combined 'Convert role to collection format and run ansible-lint' step into a 'Convert role to collection format' step running 'tox -e collection' and a separate 'Run ansible-lint' step
  • Update ansible-lint tox invocation to no longer include the 'collection' environment in the '-e' list, relying on the prior collection step instead
.github/workflows/ansible-lint.yml
Refactor ansible-test workflow to separate collection build from ansible-test execution and adjust tox invocation accordingly.
  • Split combined 'Convert role to collection format and run ansible-test' step into a 'Convert role to collection format' step running 'tox -e collection' and a separate 'Run ansible-test' step
  • Update ansible-test tox invocation to no longer include the 'collection' environment in the '-e' list, relying on the prior collection step instead
.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 3.18.1 is duplicated across several workflows; consider centralizing this (e.g., via a reusable workflow or shared env/variable) to avoid future version skew between jobs.
  • In the ansible-* workflows, you're installing tox-lsr before actions/setup-python; consider moving the installation after Python setup so that the tools are installed into the same interpreter/environment used by the subsequent tox runs.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The tox-lsr version string `3.18.1` is duplicated across several workflows; consider centralizing this (e.g., via a reusable workflow or shared env/variable) to avoid future version skew between jobs.
- In the ansible-* workflows, you're installing tox-lsr before `actions/setup-python`; consider moving the installation after Python setup so that the tools are installed into the same interpreter/environment used by the subsequent tox runs.

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 09f4336 into main Apr 9, 2026
16 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