Skip to content

ci: Comply with Ansible partner certification checking [citest_skip]#306

Merged
richm merged 1 commit intomainfrom
ci-ansible-lint-ansible-test-matrix
Apr 8, 2026
Merged

ci: Comply with Ansible partner certification checking [citest_skip]#306
richm merged 1 commit intomainfrom
ci-ansible-lint-ansible-test-matrix

Conversation

@richm
Copy link
Copy Markdown
Collaborator

@richm richm commented Apr 8, 2026

https://github.com/ansible-collections/partner-certification-checker/blob/main/README.md

Unfortunately we cannot use the checkers provided by their team because they assume
the git repo is in collection format - you cannot convert to collection format first
then point the checkers at that collection. Instead, implement our own checkers that
do the same (and more) - check with multiple versions of ansible-lint and ansible-test
to ensure we cover:

  • all supported versions of EL
  • Automation Hub gating
  • the latest versions of Ansible, including the latest milestone version

This requires the latest version of tox-lsr

Signed-off-by: Rich Megginson rmeggins@redhat.com

Summary by Sourcery

Align CI linting and testing workflows with Ansible partner certification requirements by driving ansible-lint and ansible-test through tox across multiple supported Ansible and Python versions.

CI:

  • Run ansible-lint in CI via tox using a matrix of supported ansible-lint, ansible-core, and Python versions instead of the ansible-lint GitHub Action and custom collection requirement merging.
  • Run ansible-test sanity checks in CI via tox across a matrix of Ansible core and Python versions, including milestone and latest releases, replacing the ansible-test GitHub Action.
  • Upgrade all GitHub workflows to use tox-lsr 3.18.0 for linting, testing, and integration jobs.

https://github.com/ansible-collections/partner-certification-checker/blob/main/README.md

Unfortunately we cannot use the checkers provided by their team because they assume
the git repo is in collection format - you cannot convert to collection format first
then point the checkers at that collection.  Instead, implement our own checkers that
do the same (and more) - check with multiple versions of ansible-lint and ansible-test
to ensure we cover:

* all supported versions of EL
* Automation Hub gating
* the latest versions of Ansible, including the latest milestone version

This requires the latest version of tox-lsr

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@richm richm self-assigned this Apr 8, 2026
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented Apr 8, 2026

Reviewer's Guide

Updates CI workflows to align with Ansible partner certification expectations by running ansible-lint and ansible-test via tox/tox-lsr across multiple Ansible/Python versions, and bumps tox-lsr to 3.18.0 in all workflows.

Sequence diagram for updated ansible-lint CI job with version matrix

sequenceDiagram
  actor Developer
  participant GitHub
  participant Workflow_ansible_lint as Workflow_ansible_lint_yml
  participant Runner as Actions_runner
  participant tox_lsr as tox_lsr_3_18_0
  participant tox
  participant ansible_lint as ansible_lint_matrix_version
  participant ansible_core as ansible_core_matrix_version

  Developer->>GitHub: Push commit or open PR
  GitHub->>Workflow_ansible_lint: Trigger workflow (no citest_skip)
  Workflow_ansible_lint->>Runner: Start job ansible-lint with matrix

  loop For each matrix version
    Runner->>Runner: Set matrix vars (ansible_lint, ansible_core, python)
    Runner->>Runner: Setup Python version from matrix
    Runner->>tox_lsr: pip install tox-lsr 3.18.0
    Runner->>tox: Run tox with env collection and ansible-lint-collection
    tox->>ansible_core: Install ansible-core==matrix.ansible
    tox->>ansible_lint: Install ansible-lint==matrix.ansible_lint
    tox->>tox_lsr: Use collection testenv definitions
    tox->>ansible_lint: Execute ansible-lint on converted collection
    ansible_lint-->>tox: Lint results
    tox-->>Runner: Job status for this matrix version
  end

  Runner-->>Workflow_ansible_lint: Combined matrix result
  Workflow_ansible_lint-->>GitHub: Report CI status
  GitHub-->>Developer: Show ansible-lint checks per version
Loading

File-Level Changes

Change Details Files
Run ansible-lint via tox across a matrix of Ansible/ansible-lint/Python versions instead of using the ansible-lint GitHub Action on a pre-converted collection.
  • Add a matrix strategy with fail-fast disabled and two (ansible-lint, ansible-core, python) version tuples to the ansible-lint workflow job.
  • Upgrade tox-lsr used in the ansible-lint workflow from 3.17.1 to 3.18.0.
  • Introduce actions/setup-python to select the matrix Python version for ansible-lint.
  • Replace the explicit collection conversion plus ansible-lint GitHub Action invocation with a single tox call that converts the role to a collection and runs ansible-lint-collection using matrix-driven dependency pins.
.github/workflows/ansible-lint.yml
Run ansible-test via tox across multiple Ansible/Python versions instead of the ansible-test GitHub Action, and add a corresponding version matrix.
  • Add a matrix strategy with fail-fast disabled and multiple (ansible, python) version combinations to the ansible-test workflow job, including stable and milestone versions.
  • Upgrade tox-lsr used in the ansible-test workflow from 3.17.1 to 3.18.0.
  • Introduce actions/setup-python to select the matrix Python version for ansible-test.
  • Replace the simple collection conversion plus ansible-test GitHub Action step with a tox invocation that both converts to a collection and runs the appropriate ansible-test- environment based on the matrix.
.github/workflows/ansible-test.yml
Standardize on tox-lsr 3.18.0 across remaining GitHub workflows.
  • Bump tox-lsr from 3.17.1 to 3.18.0 in the ansible-managed-var-comment workflow.
  • Bump tox-lsr from 3.17.1 to 3.18.0 in the python-unit-test workflow while keeping the existing tox/virtualenv logic.
  • Bump tox-lsr from 3.17.1 to 3.18.0 in the qemu-kvm-integration-tests workflow.
.github/workflows/ansible-managed-var-comment.yml
.github/workflows/python-unit-test.yml
.github/workflows/qemu-kvm-integration-tests.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 ansible/ansible‑test version matrices are hard‑coded in the workflow; consider moving these into tox/lsr configuration (or a small shared YAML anchor/reusable workflow) so version changes only need to be updated in one place.
  • The tox‑lsr git ref (3.18.0) is duplicated across multiple workflows; factoring this into a single reusable workflow or a shared environment variable will reduce the risk of the workflows drifting out of sync on future updates.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The ansible/ansible‑test version matrices are hard‑coded in the workflow; consider moving these into tox/lsr configuration (or a small shared YAML anchor/reusable workflow) so version changes only need to be updated in one place.
- The tox‑lsr git ref (3.18.0) is duplicated across multiple workflows; factoring this into a single reusable workflow or a shared environment variable will reduce the risk of the workflows drifting out of sync on future updates.

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 31ba4b9 into main Apr 8, 2026
14 checks passed
@richm richm deleted the ci-ansible-lint-ansible-test-matrix branch April 8, 2026 22:16
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