Skip to content

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

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]#230
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 conversion from lint and test execution.

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 steps for converting the role to a collection and running lint/tests, simplifying the tox environments invoked.

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 the collection build and test execution run as separate tox invocations, aligning with new dependency handling requirements.

Sequence diagram for updated ansible-lint CI workflow

sequenceDiagram
    actor Developer
    participant GitHubActions
    participant ansible_lint_workflow
    participant tox

    Developer->>GitHubActions: Push or PR triggers workflow
    GitHubActions->>ansible_lint_workflow: Start ansible-lint job

    ansible_lint_workflow->>ansible_lint_workflow: Check out repository
    ansible_lint_workflow->>ansible_lint_workflow: Set up Python matrix

    ansible_lint_workflow->>ansible_lint_workflow: pip3 install tox_lsr_3_18_1

    ansible_lint_workflow->>tox: tox -e collection
    tox-->>ansible_lint_workflow: Build role as collection and install requirements

    ansible_lint_workflow->>ansible_lint_workflow: Set LSR_ANSIBLE_LINT_DEP
    ansible_lint_workflow->>ansible_lint_workflow: Set LSR_ANSIBLE_LINT_ANSIBLE_DEP

    ansible_lint_workflow->>tox: tox -x testenv_ansible_lint_collection_basepython
    tox->>tox: Run ansible-lint-collection env
    tox-->>ansible_lint_workflow: ansible-lint results

    ansible_lint_workflow-->>GitHubActions: Report job status
    GitHubActions-->>Developer: CI status for ansible-lint
Loading

File-Level Changes

Change Details Files
Bump tox-lsr version in all relevant GitHub Actions workflows.
  • Change pip installation target from tox-lsr@3.18.0 to tox-lsr@3.18.1 in CI jobs that rely on tox-lsr.
  • Ensure qemu-kvm integration tests and ansible-related workflows use 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/qemu-kvm-integration-tests.yml
Refactor ansible-lint workflow to separate collection build from lint execution.
  • Introduce a dedicated step that runs only tox -e collection to convert the role to collection format.
  • Adjust the ansible-lint step to execute only the ansible-lint-collection environment via tox, removing collection from the environment list.
  • Preserve environment variables configuring ansible-lint and ansible-core versions while changing the tox invocation structure.
.github/workflows/ansible-lint.yml
Refactor ansible-test workflow to separate collection build from test execution.
  • Add a standalone step that runs tox -e collection before tests.
  • Modify the ansible-test step to run only the appropriate ansible-test-<version> tox environment, dropping collection from the environment list.
  • Retain per-matrix basepython override while simplifying the tox -e list.
.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 537ee45 into main Apr 9, 2026
11 checks passed
@richm richm deleted the ci-ansible-lint-install-deps branch April 9, 2026 23:12
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