Skip to content

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

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]#249
richm merged 1 commit into
mainfrom
ci-ansible-lint-install-deps

Conversation

@richm

@richm richm commented Apr 9, 2026

Copy link
Copy Markdown
Contributor

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 collection conversion from lint/test execution.

CI:

  • Bump tox-lsr version to 3.18.1 across all GitHub Actions workflows.
  • Split ansible-lint and ansible-test workflows into distinct steps for collection conversion and subsequent lint/test runs.

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 ueno as a code owner April 9, 2026 23:01
@sourcery-ai

sourcery-ai Bot commented Apr 9, 2026

Copy link
Copy Markdown
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 collection conversion and lint/test execution run as separate tox environments instead of a combined invocation.

Sequence diagram for updated ansible-lint CI workflow

sequenceDiagram
    participant GitHubActionsRunner as GitHubActionsRunner
    participant Pip as pip3
    participant Tox as tox
    participant ToxLsr as tox_lsr_3_18_1
    participant AnsibleLintEnv as ansible_lint_collection_env

    GitHubActionsRunner->>Pip: install tox and tox_lsr_3_18_1
    Pip-->>GitHubActionsRunner: tox and tox_lsr_3_18_1 installed

    GitHubActionsRunner->>GitHubActionsRunner: setup Python matrix.versions.python

    GitHubActionsRunner->>Tox: run environment collection
    Tox->>ToxLsr: convert role to collection format
    ToxLsr-->>Tox: collection layout prepared
    Tox-->>GitHubActionsRunner: collection environment complete

    GitHubActionsRunner->>Tox: run environment ansible-lint-collection
    Tox->>AnsibleLintEnv: set LSR_ANSIBLE_LINT_DEP ansible-lint==matrix.versions.ansible_lint
    Tox->>AnsibleLintEnv: set LSR_ANSIBLE_LINT_ANSIBLE_DEP ansible-core==matrix.versions.ansible
    Tox->>AnsibleLintEnv: use basepython python{matrix.versions.python}
    AnsibleLintEnv-->>GitHubActionsRunner: ansible-lint results
Loading

File-Level Changes

Change Details Files
Bump tox-lsr dependency version in all GitHub workflows that use it.
  • Update pip/pip3 install commands to reference tox-lsr@3.18.1 instead of 3.18.0 in multiple workflows
  • Keep the rest of the workflow logic and job matrices unchanged
.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
Split collection build from ansible-lint and ansible-test execution in CI.
  • Add dedicated steps that run tox -e collection before lint/test steps in ansible-lint and ansible-test workflows
  • Adjust ansible-lint workflow tox invocation to run only -e ansible-lint-collection while keeping env var overrides for ansible and ansible-lint versions
  • Adjust ansible-test workflow tox invocation to run only the relevant ansible-test-<version> env while still overriding basepython via tox -x option
.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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

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:

  • In the workflows where you pip3 install tox-lsr before actions/setup-python, consider installing with the matrix Python (e.g. after setup using python -m pip) to avoid mixing system Python with the version used by tox and the tests.
  • Since the tox-lsr version is now repeated across multiple workflows, consider centralizing it via a workflow env variable or a reusable workflow input to reduce the risk of future version drift between CI jobs.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the workflows where you `pip3 install` tox-lsr before `actions/setup-python`, consider installing with the matrix Python (e.g. after setup using `python -m pip`) to avoid mixing system Python with the version used by tox and the tests.
- Since the tox-lsr version is now repeated across multiple workflows, consider centralizing it via a workflow env variable or a reusable workflow input to reduce the risk of future version drift between CI jobs.

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