Skip to content

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

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]#328
richm merged 1 commit intomainfrom
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 release and separate collection conversion from ansible lint/test steps.

CI:

  • Bump tox-lsr dependency from 3.18.0 to 3.18.1 across GitHub Actions workflows.
  • Split ansible-lint and ansible-test workflows into distinct collection-conversion and test execution steps while reusing the generated collection.

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 review from rjeffman and spetrosi as code owners April 9, 2026 23:00
@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 and ansible-test GitHub Actions so that collection conversion and lint/test execution run as separate tox environments instead of a combined invocation.

Sequence diagram for updated ansible-lint GitHub Action job

sequenceDiagram
  participant GH as GitHubActions
  participant J as ansible-lint_job
  participant R as Runner
  participant P as actions_setup_python
  participant Pip as pip_tox-lsr_3_18_1
  participant T as tox
  participant C as tox_env_collection
  participant L as tox_env_ansible-lint-collection
  participant AL as ansible-lint
  participant AC as ansible-core

  GH->>J: Trigger workflow run
  J->>R: Start job on runner
  R->>P: Setup Python with matrix version
  P-->>R: Python environment ready

  R->>Pip: Install tox-lsr 3.18.1 via pip3
  Pip-->>R: tox-lsr installed

  R->>T: Run tox -e collection
  T->>C: Execute collection environment
  C->>AC: Install ansible-core dependency
  C->>AL: Install ansible-lint dependency
  C-->>T: Collection conversion completed
  T-->>R: collection environment done

  R->>T: Run tox -e ansible-lint-collection
  T->>L: Execute ansible-lint-collection environment
  L->>AL: Run ansible-lint on converted collection
  L->>AC: Use ansible-core version from matrix
  L-->>T: Linting completed
  T-->>R: ansible-lint-collection environment done

  R-->>J: Job completed
  J-->>GH: Report ansible-lint job status
Loading

File-Level Changes

Change Details Files
Upgrade tox-lsr version used across all CI workflows to 3.18.1.
  • Bump tox-lsr pip install reference from 3.18.0 to 3.18.1 in GitHub Actions workflows for ansible-lint, ansible-test, ansible-managed-var-comment, python-unit-test, and qemu-kvm-integration-tests.
  • Ensure all CI jobs consistently install the same updated 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 build from ansible-lint execution and rely on tox-lsr to handle collection dependency installation.
  • Split the combined step into a dedicated tox -e collection step followed by a separate step that runs ansible-lint via tox.
  • Adjust tox invocation for ansible-lint to only run the ansible-lint-collection environment, removing collection from the -e list while preserving custom ansible-lint and ansible-core dependency variables.
.github/workflows/ansible-lint.yml
Refactor ansible-test workflow to separate collection build from ansible-test execution while simplifying the tox environment selection.
  • Add a standalone step to run tox -e collection before executing ansible-test.
  • Update the ansible-test tox invocation to run only the ansible-test-${{ matrix.versions.ansible }} environment, dropping collection from the -e list while keeping the basepython override.
.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 several workflows; consider centralizing it via a top-level env variable or a reusable workflow so future version bumps only need to be made in one place.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The tox-lsr version string is duplicated across several workflows; consider centralizing it via a top-level `env` variable or a reusable workflow so future version bumps only need to be made in one place.

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