Skip to content

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

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]#180
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 tox-lsr 3.18.1 and separate Ansible collection conversion from lint and test execution.

CI:

  • Bump tox-lsr to version 3.18.1 across ansible-related GitHub Actions workflows.
  • Split collection conversion into a dedicated tox step before running ansible-lint and ansible-test in CI.

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:01
@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/test jobs to run collection conversion and testing as separate tox environments, aligning with new dependency-handling behavior.

Sequence diagram for updated ansible-lint GitHub Actions workflow

sequenceDiagram
    actor Developer
    participant GitHubActionsRunner as GitHubActionsRunner
    participant Pip as Pip
    participant Tox as Tox
    participant ToxLsr as ToxLsr

    Developer->>GitHubActionsRunner: Push or PR triggers ansible-lint workflow

    GitHubActionsRunner->>Pip: Install tox-lsr 3.18.1
    Pip-->>GitHubActionsRunner: tox-lsr 3.18.1 installed

    GitHubActionsRunner->>GitHubActionsRunner: Set up Python with matrix.versions.python

    GitHubActionsRunner->>Tox: Run environment collection
    Tox->>ToxLsr: Use tox-lsr 3.18.1 to convert role to collection
    ToxLsr-->>Tox: Collection layout and dependencies prepared
    Tox-->>GitHubActionsRunner: collection environment completed

    GitHubActionsRunner->>Tox: Run environment ansible-lint-collection
    GitHubActionsRunner->>Tox: Export LSR_ANSIBLE_LINT_DEP and LSR_ANSIBLE_LINT_ANSIBLE_DEP
    Tox->>ToxLsr: Use prepared collection and installed dependencies
    ToxLsr-->>GitHubActionsRunner: ansible-lint results
Loading

File-Level Changes

Change Details Files
Update CI to use tox-lsr 3.18.1 across workflows.
  • Bump tox-lsr GitHub install reference from version 3.18.0 to 3.18.1 in ansible-lint workflow.
  • Bump tox-lsr GitHub install reference from version 3.18.0 to 3.18.1 in ansible-test workflow.
  • Bump tox-lsr GitHub install reference from version 3.18.0 to 3.18.1 in ansible-managed-var-comment workflow.
  • Bump tox-lsr GitHub install reference from version 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/qemu-kvm-integration-tests.yml
Refactor ansible-lint and ansible-test workflows to run collection conversion separately from lint/test tox environments, matching ansible-lint dependency requirements.
  • Split the combined 'Convert role to collection format and run ansible-lint' job step into two steps: one running 'tox -e collection' and a separate one running ansible-lint.
  • Adjust the ansible-lint tox invocation to remove the 'collection' environment from '-e' so only 'ansible-lint-collection' runs after the dedicated collection step.
  • Split the combined 'Convert role to collection format and run ansible-test' job step into two steps: one running 'tox -e collection' and a separate one running ansible-test.
  • Adjust the ansible-test tox invocation to remove the 'collection' environment from '-e' so only the relevant 'ansible-test-${{ matrix.versions.ansible }}' environment runs after the dedicated collection step.
.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:

  • Since actions/setup-python runs after the pip3 install of tox-lsr, consider moving the install step below setup-python so tox-lsr is installed into the configured Python environment rather than the runner’s default Python.
  • Now that tox -e collection runs in its own step in both workflows, it might be worth clarifying in the tox config (e.g., via dependencies or comments) that ansible-lint-collection and ansible-test-* environments assume the collection environment has already been executed.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Since `actions/setup-python` runs after the `pip3 install` of tox-lsr, consider moving the install step below `setup-python` so tox-lsr is installed into the configured Python environment rather than the runner’s default Python.
- Now that `tox -e collection` runs in its own step in both workflows, it might be worth clarifying in the tox config (e.g., via dependencies or comments) that `ansible-lint-collection` and `ansible-test-*` environments assume the collection environment has already been executed.

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