Skip to content

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

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]#498
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 and split collection conversion from lint/test execution.

CI:

  • Bump tox-lsr version to 3.18.1 in ansible-related GitHub Actions workflows.
  • Separate the collection conversion step from ansible-lint and ansible-test runs in CI workflows to allow proper dependency installation.

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 and ansible-test jobs so the collection build step runs separately from the lint/test steps, ensuring required Ansible collection dependencies are installed before running.

Sequence diagram for separated collection build and ansible-lint steps in CI

sequenceDiagram
  participant GitHubActionsRunner
  participant tox
  participant tox_lsr_3_18_1
  participant CollectionEnv as tox_env_collection
  participant LintEnv as tox_env_ansible_lint_collection
  participant ansible_lint
  participant ansible_core

  GitHubActionsRunner->>GitHubActionsRunner: Checkout code
  GitHubActionsRunner->>GitHubActionsRunner: Setup Python matrix version
  GitHubActionsRunner->>tox_lsr_3_18_1: Install tox-lsr 3.18.1 via pip

  Note over GitHubActionsRunner,CollectionEnv: Convert role to collection format
  GitHubActionsRunner->>tox: Run tox -e collection
  tox->>tox_lsr_3_18_1: Resolve env collection
  tox_lsr_3_18_1->>CollectionEnv: Create and configure env
  CollectionEnv->>CollectionEnv: Build collection
  CollectionEnv->>CollectionEnv: Install collection dependencies from meta/collection-requirements.yml
  CollectionEnv->>CollectionEnv: Install test dependencies from tests/collection-requirements.yml

  Note over GitHubActionsRunner,LintEnv: Run ansible-lint on built collection
  GitHubActionsRunner->>tox: Run tox -e ansible-lint-collection
  tox->>tox_lsr_3_18_1: Resolve env ansible-lint-collection
  tox_lsr_3_18_1->>LintEnv: Create and configure env with Python version
  LintEnv->>ansible_core: Install ansible-core==matrix.versions.ansible
  LintEnv->>ansible_lint: Install ansible-lint==matrix.versions.ansible_lint
  LintEnv->>ansible_lint: Execute ansible-lint against collection
  ansible_lint-->>GitHubActionsRunner: Report lint results
Loading

File-Level Changes

Change Details Files
Bump tox-lsr to 3.18.1 across CI workflows to ensure Ansible collection dependencies are installed correctly.
  • Update pip installation command in ansible-lint workflow to use tox-lsr 3.18.1.
  • Update pip installation command in ansible-test workflow to use tox-lsr 3.18.1.
  • Update pip installation command in ansible-managed-var-comment workflow to use tox-lsr 3.18.1.
  • Update pip installation command in qemu-kvm-integration-tests workflow to use tox-lsr 3.18.1.
.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 GitHub Actions job to separate collection build from lint execution.
  • Split combined collection+ansible-lint step into a dedicated "Convert role to collection format" step running tox -e collection.
  • Adjust ansible-lint step to only run the ansible-lint collection environment, removing collection from the tox -e list.
  • Preserve environment variable wiring for ansible-lint and ansible-core versions and explicit basepython override.
.github/workflows/ansible-lint.yml
Refactor ansible-test GitHub Actions job to separate collection build from ansible-test execution.
  • Split combined collection+ansible-test step into a dedicated "Convert role to collection format" step running tox -e collection.
  • Adjust ansible-test step to only run the ansible-test environment, removing collection from the tox -e list.
  • Keep explicit basepython override for the ansible-test tox environment while simplifying the env 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 left some high level feedback:

  • Consider centralizing the tox-lsr version (e.g., as a workflow env var or reusable workflow input) so future version bumps only require a single change instead of updating each workflow separately.
  • Since the collection tox env is now run as a separate step in multiple workflows, you might factor it into a reusable workflow or composite action to avoid duplication and ensure consistent behavior.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider centralizing the tox-lsr version (e.g., as a workflow env var or reusable workflow input) so future version bumps only require a single change instead of updating each workflow separately.
- Since the `collection` tox env is now run as a separate step in multiple workflows, you might factor it into a reusable workflow or composite action to avoid duplication and ensure consistent behavior.

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