Skip to content

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

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

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

Conversation

@richm
Copy link
Copy Markdown
Collaborator

@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 lint and test runs.

CI:

  • Bump tox-lsr used in GitHub Actions workflows from 3.18.0 to 3.18.1.
  • Refine ansible-lint and ansible-test workflows to run collection conversion in a dedicated step before executing lint and test environments.

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/test workflows to separate the collection-conversion step from running ansible-lint/ansible-test, relying on tox-lsr to install required Ansible collection dependencies.

Flow diagram for refactored ansible-lint GitHub Actions job

flowchart TD
  start["Start ansible-lint workflow job"] --> checkout["Checkout repository"]
  checkout --> install_tox_lsr["Install tox-lsr 3.18.1 via pip"]
  install_tox_lsr --> setup_python["Set up Python version from matrix"]

  setup_python --> convert_collection["Run tox -e collection (convert role to collection)"]
  convert_collection --> install_collections["Install Ansible collection dependencies from meta/collection-requirements.yml and tests/collection-requirements.yml"]

  install_collections --> run_lint["Run tox -e ansible-lint-collection"]
  run_lint --> ansible_lint["Execute ansible-lint with pinned ansible-core and ansible-lint versions"]
  ansible_lint --> end_node["Job completes"]
Loading

File-Level Changes

Change Details Files
Upgrade tox-lsr version used in GitHub Actions workflows to 3.18.1 for improved handling of Ansible collection dependencies.
  • Bump tox-lsr from 3.18.0 to 3.18.1 in ansible-lint workflow
  • Bump tox-lsr from 3.18.0 to 3.18.1 in ansible-test workflow
  • Bump tox-lsr from 3.18.0 to 3.18.1 in ansible-managed-var-comment workflow
  • Bump 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/qemu-kvm-integration-tests.yml
Refactor ansible-lint and ansible-test workflows to run collection conversion and tests in distinct tox environments, relying on tox-lsr to install collection requirements.
  • Split combined 'Convert role to collection format and run ansible-lint' step into separate 'Convert role to collection format' and 'Run ansible-lint' steps
  • Run tox -e collection in its own step before ansible-lint, instead of including collection in the tox env list for the lint step
  • Adjust ansible-lint tox invocation to only run ansible-lint-collection environment while preserving ansible/ansible-lint/python matrix overrides
  • Split combined 'Convert role to collection format and run ansible-test' step into separate 'Convert role to collection format' and 'Run ansible-test' steps
  • Adjust ansible-test tox invocation to only run the ansible-test-${{ matrix.versions.ansible }} environment, removing 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 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 6ce8c00 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