Skip to content

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

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]#140
richm merged 1 commit into
mainfrom
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 Ansible collection conversion from linting and testing steps.

CI:

  • Bump tox-lsr version to 3.18.1 across ansible-lint, ansible-test, ansible-managed-var-comment, python-unit-test, and qemu-kvm-integration-tests workflows.
  • Refine ansible-lint and ansible-test workflows to run collection conversion in a dedicated step before invoking their respective tox 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
@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/test workflows so that collection conversion is executed in a dedicated tox step before running ansible-lint and ansible-test.

Flow diagram for refactored ansible-lint GitHub Actions job

flowchart TD
  start[Start ansible-lint workflow job]
  install_tox_lsr[Install tox-lsr 3.18.1 via pip3]
  setup_python[Set up Python using actions/setup-python]
  convert_collection[Run tox -e collection to convert role to collection format]
  set_env_vars[Set LSR_ANSIBLE_LINT_DEP and LSR_ANSIBLE_LINT_ANSIBLE_DEP]
  run_tox_ansible_lint[Run tox -e ansible-lint-collection with configured basepython]
  finish[Job completed]

  start --> install_tox_lsr
  install_tox_lsr --> setup_python
  setup_python --> convert_collection
  convert_collection --> set_env_vars
  set_env_vars --> run_tox_ansible_lint
  run_tox_ansible_lint --> finish
Loading

File-Level Changes

Change Details Files
Bump tox-lsr to version 3.18.1 across CI workflows.
  • Update pip install commands in GitHub Actions workflows to reference tox-lsr@3.18.1 instead of 3.18.0.
  • Ensure both python-based and system python invocations (pip and pip3) consistently use the new tox-lsr version.
.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 conversion from lint execution.
  • Split the combined "Convert role to collection format and run ansible-lint" step into two steps: one running tox -e collection and another running tox -e ansible-lint-collection.
  • Remove collection from the env list in the ansible-lint tox invocation so it only runs the lint environment after collection conversion is done.
  • Preserve and continue to pass the ansible-lint and ansible-core version parameters and the basepython override to the ansible-lint tox environment.
.github/workflows/ansible-lint.yml
Refactor ansible-test workflow to separate collection conversion from ansible-test execution.
  • Split the combined "Convert role to collection format and run ansible-test" step into two steps: one running tox -e collection and another running tox -e ansible-test-${{ matrix.versions.ansible }}.
  • Remove collection from the env list in the ansible-test tox invocation so it only runs the ansible-test environment after collection conversion is done.
  • Retain the basepython override on the ansible-test tox environment to keep Python matrix behavior unchanged.
.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 defining it once via a top-level env variable or a shared/reusable workflow so future version bumps only require a single change.
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 defining it once via a top-level `env` variable or a shared/reusable workflow so future version bumps only require a single change.

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 07d7aa0 into main Apr 9, 2026
14 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