Skip to content

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

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]#286
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 newer tox-lsr release and split Ansible collection conversion from lint/test execution.

CI:

  • Bump tox-lsr version to 3.18.1 across ansible-lint, ansible-test, ansible-managed-var-comment, and qemu-kvm integration workflows.
  • Refine ansible-lint workflow to run collection conversion and ansible-lint in separate steps, invoking only the ansible-lint-collection tox environment.
  • Refine ansible-test workflow to separate collection conversion from ansible-test execution, running only the ansible-test tox environment.

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

sourcery-ai Bot commented Apr 9, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Update GitHub Actions CI workflows to use tox-lsr 3.18.1 and split collection conversion from ansible-lint/ansible-test execution so that required Ansible collection dependencies are installed correctly before linting and testing.

Flow diagram for updated ansible-lint GitHub Actions workflow

flowchart TD
  A[GitHub_Actions ansible-lint workflow trigger] --> B[Checkout repository]
  B --> C[Install tox and tox-lsr 3_18_1 via pip3]
  C --> D[Set up Python using actions_setup-python]
  D --> E[Run tox environment collection]
  E --> F[Install collection dependencies<br>from meta_collection-requirements_yml<br>and tests_collection-requirements_yml]
  F --> G[Run tox environment ansible-lint-collection<br>with LSR_ANSIBLE_LINT_DEP and<br>LSR_ANSIBLE_LINT_ANSIBLE_DEP]
  G --> H[ansible-lint executes against<br>converted collection]
  H --> I[Job status reported back to GitHub]
Loading

File-Level Changes

Change Details Files
Bump tox-lsr to 3.18.1 in CI workflows to ensure collection dependencies are installed.
  • Update pip installation command to point to tox-lsr version 3.18.1 in ansible-lint workflow.
  • Update pip installation command to point to tox-lsr version 3.18.1 in ansible-test workflow.
  • Update pip installation command to point to tox-lsr version 3.18.1 in ansible-managed-var-comment workflow.
  • Update pip installation command to point to tox-lsr version 3.18.1 in 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 and ansible-test workflows to separate collection conversion from lint/test runs.
  • Introduce a dedicated step that runs tox -e collection before the ansible-lint step.
  • Adjust ansible-lint tox invocation to only run the ansible-lint-collection environment, keeping collection conversion in its own step.
  • Introduce a dedicated step that runs tox -e collection before the ansible-test step.
  • Adjust ansible-test tox invocation to only run the ansible-test-${{ matrix.versions.ansible }} environment, assuming collection conversion has already occurred.
.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
Contributor

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 installation command is duplicated across multiple workflows; consider extracting it (and possibly the collection conversion step) into a reusable workflow or composite action to keep the CI config DRY and easier to update next time.
  • Now that the collection build is a separate step, you may want to explicitly declare needs dependencies (or at least confirm the default step ordering is sufficient) so that future edits don’t accidentally re-order steps and break the expected sequence of collectionansible-lint/ansible-test.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The tox-lsr installation command is duplicated across multiple workflows; consider extracting it (and possibly the collection conversion step) into a reusable workflow or composite action to keep the CI config DRY and easier to update next time.
- Now that the collection build is a separate step, you may want to explicitly declare `needs` dependencies (or at least confirm the default step ordering is sufficient) so that future edits don’t accidentally re-order steps and break the expected sequence of `collection``ansible-lint`/`ansible-test`.

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