Skip to content

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

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]#205
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 build from ansible lint/test steps.

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 collection-conversion and lint/test steps while 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
@richm richm requested a review from spetrosi as a code owner April 9, 2026 23:01
@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 that converting the role to a collection is a separate tox step from running lint/tests, leveraging tox-lsr’s updated behavior for installing collection dependencies.

Sequence diagram for separated collection and ansible-lint tox steps

sequenceDiagram
  participant GA as GitHub_Actions
  participant Job as Job_ansible_lint
  participant Py as Python_Runtime
  participant TL as Tox_lsr_3_18_1
  participant Tox as Tox
  participant Coll as Env_collection
  participant LintEnv as Env_ansible_lint_collection
  participant DepMeta as meta_collection_requirements_yml
  participant DepTests as tests_collection_requirements_yml
  participant AL as ansible_lint
  participant AC as ansible_core

  GA->>Job: Start job with matrix versions
  Job->>Py: Setup Python matrix_version
  Job->>TL: Install tox_lsr_3_18_1 via pip3

  Job->>Tox: Run tox -e collection
  activate Tox
  Tox->>Coll: Initialize env_collection
  Coll->>DepMeta: Install collection dependencies
  Coll->>DepTests: Install test collection dependencies
  deactivate Tox

  Job->>Tox: Run tox -e ansible-lint-collection with env vars
  activate Tox
  Tox->>LintEnv: Initialize env_ansible_lint_collection
  LintEnv->>AC: Install ansible_core matrix_version
  LintEnv->>AL: Install ansible_lint matrix_version
  LintEnv->>AL: Run ansible_lint on converted collection
  deactivate Tox

  AL-->>Job: Lint results
  Job-->>GA: Report job status
Loading

File-Level Changes

Change Details Files
Bump tox-lsr version used in GitHub Actions workflows to 3.18.1.
  • Update pip install command in CI jobs to reference tox-lsr@3.18.1 instead of 3.18.0.
  • Ensure all relevant workflows consistently use the same tox-lsr version.
.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 workflow to separate collection generation from running ansible-lint.
  • Add a dedicated CI step that runs tox -e collection to convert the role to collection format.
  • Adjust the ansible-lint step to only run the ansible-lint tox environment, removing collection from the environment list.
  • Preserve custom ansible/ansible-lint/python version selection via tox overrides for the ansible-lint environment.
.github/workflows/ansible-lint.yml
Refactor ansible-test workflow to separate collection generation from running ansible-test.
  • Add a dedicated CI step that runs tox -e collection before tests.
  • Update the ansible-test step to invoke only the ansible-test tox environment and drop collection from the environment list.
  • Keep the dynamic basepython override for the ansible-test tox environment based on the matrix python version.
.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 reviewed your changes and they look great!


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