Skip to content

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

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]#124
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 newer tox-lsr release and separate Ansible collection conversion from lint and test steps.

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 collection-conversion and test execution steps while keeping existing test matrices unchanged.

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 splits Ansible collection conversion from lint/test runs so dependencies from collection requirements are installed correctly before ansible-lint and ansible-test execute.

Flow diagram for updated ansible-lint GitHub Actions job

flowchart TD
  trigger["Push/PR event to ansible-lint workflow"] --> setup_python
  setup_python["Setup Python (actions/setup-python)"] --> install_tox_lsr
  install_tox_lsr["pip install tox-lsr 3.18.1"] --> convert_collection
  convert_collection["tox -e collection (convert role to collection format and install collection requirements)"] --> run_ansible_lint
  run_ansible_lint["tox -e ansible-lint-collection with LSR_ANSIBLE_LINT_DEP and LSR_ANSIBLE_LINT_ANSIBLE_DEP"]
Loading

File-Level Changes

Change Details Files
Bump tox-lsr version in CI workflows to 3.18.1 so it installs Ansible collection dependencies before running tooling.
  • Update pip installation of tox-lsr from version 3.18.0 to 3.18.1 in the ansible-lint workflow.
  • Update pip installation of tox-lsr from version 3.18.0 to 3.18.1 in the ansible-test workflow.
  • Update pip installation of tox-lsr from version 3.18.0 to 3.18.1 in the ansible-managed-var-comment workflow.
  • Update pip installation of tox-lsr from version 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 and ansible-test workflows to run collection conversion separately from lint/test execution.
  • In the ansible-lint workflow, add a dedicated step that runs tox -e collection before linting.
  • In the ansible-lint workflow, adjust the ansible-lint step to only run the ansible-lint-collection environment and remove collection from the environment list.
  • In the ansible-test workflow, add a dedicated step that runs tox -e collection before tests.
  • In the ansible-test workflow, adjust the ansible-test step to only run the ansible-test-${{ matrix.versions.ansible }} environment and remove collection from the environment list.
.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

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:

  • In the new separate Convert role to collection format steps you dropped set -euxo pipefail, which you still use in the other shell steps in these workflows; consider adding it back for consistency and to avoid silent failures in the tox -e collection run.
  • Now that tox -e collection runs in its own step, double‑check whether any jobs depend on artifacts or side effects from that environment; if so, it might be safer to make the ansible-lint/ansible-test steps explicitly depend on the collection step via needs to make this ordering requirement clear.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the new separate `Convert role to collection format` steps you dropped `set -euxo pipefail`, which you still use in the other shell steps in these workflows; consider adding it back for consistency and to avoid silent failures in the `tox -e collection` run.
- Now that `tox -e collection` runs in its own step, double‑check whether any jobs depend on artifacts or side effects from that environment; if so, it might be safer to make the ansible-lint/ansible-test steps explicitly depend on the collection step via `needs` to make this ordering requirement clear.

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 0549a5d into main Apr 9, 2026
12 of 14 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