Skip to content

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

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]#215
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 and separate collection build from lint/test execution.

CI:

  • Bump tox-lsr to version 3.18.1 in ansible-lint, ansible-test, managed-var-comment, and qemu-kvm integration GitHub workflows.
  • Refine ansible-lint and ansible-test workflows to run the collection build and lint/test steps as separate 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
@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 to run collection conversion and testing in separate tox invocations, ensuring required collection dependencies are installed before linting/testing.

Sequence diagram for updated ansible-lint CI workflow

sequenceDiagram
    actor Developer
    participant GitHubActions as GitHub_Actions
    participant Runner as CI_Runner
    participant tox as tox
    participant toxlsr as tox_lsr_3_18_1

    Developer->>GitHubActions: Push or open_pull_request
    GitHubActions->>Runner: Start ansible_lint_workflow

    Runner->>Runner: Checkout repository

    Runner->>toxlsr: pip_install tox_lsr_3_18_1
    toxlsr-->>Runner: tox_lsr_3_18_1_installed

    Runner->>Runner: setup_python matrix_python_version

    Runner->>tox: tox -e collection
    tox-->>Runner: collection_built_with_dependencies

    Runner->>tox: tox -e ansible_lint_collection
        activate LSR_ansible_lint_env_vars
        note over Runner, tox: LSR_ANSIBLE_LINT_DEP and LSR_ANSIBLE_LINT_ANSIBLE_DEP exported
    tox-->>Runner: ansible_lint_results

    Runner-->>GitHubActions: Job_status
    GitHubActions-->>Developer: Report_lint_status
Loading

Flow diagram for separate collection and test steps in ansible-test workflow

flowchart TD
    S[Start ansible_test_workflow] --> C1[Checkout repository]
    C1 --> P1[Install tox_lsr_3_18_1]
    P1 --> PY[Setup matrix_python_version]

    PY --> COL[tox -e collection
convert_role_to_collection_format
install_collection_dependencies]

    COL --> TEST[tox -e ansible_test_collection
run_ansible_test_on_collection]

    TEST --> R[Report test_results]
    R --> E[End]
Loading

File-Level Changes

Change Details Files
Upgrade tox-lsr version used across GitHub Actions workflows to 3.18.1.
  • Bump tox-lsr installation from 3.18.0 to 3.18.1 in the ansible-lint workflow.
  • Bump tox-lsr installation from 3.18.0 to 3.18.1 in the ansible-test workflow.
  • Bump tox-lsr installation from 3.18.0 to 3.18.1 in the ansible-managed-var-comment workflow.
  • Bump tox-lsr installation from 3.18.0 to 3.18.1 in the qemu-kvm-integration-tests workflow.
.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 workflow to separate collection conversion and ansible-lint execution into distinct steps.
  • Split the combined step that converted the role to a collection and ran ansible-lint into two steps: one running tox -e collection and one running ansible-lint.
  • Adjust the tox invocation for ansible-lint to only run the ansible-lint-collection environment, relying on the prior collection step.
  • Preserve environment variable configuration for ansible-lint and ansible-core dependencies while changing the tox environment list.
.github/workflows/ansible-lint.yml
Refactor ansible-test GitHub Actions workflow to separate collection conversion and ansible-test execution into distinct steps.
  • Split the combined step that converted the role to a collection and ran ansible-test into two steps: one running tox -e collection and one running ansible-test.
  • Adjust the tox invocation for ansible-test to only run the ansible-test-${{ matrix.versions.ansible }} environment, relying on the prior collection step.
  • Keep the basepython override for the ansible-test tox environment while removing collection from the environment 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:

  • The tox-lsr version string and the separate tox -e collection steps are now duplicated across multiple workflows; consider factoring the version into a shared env/variable or a reusable workflow to keep these CI definitions DRY and easier to update.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The tox-lsr version string and the separate `tox -e collection` steps are now duplicated across multiple workflows; consider factoring the version into a shared env/variable or a reusable workflow to keep these CI definitions DRY and easier to update.

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 e9b0af2 into main Apr 9, 2026
11 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