ci: ansible-lint requires dependencies to be installed [citest_skip]#249
Merged
Conversation
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>
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates CI workflows to use tox-lsr 3.18.1 and refactors ansible-lint and ansible-test jobs so that collection conversion and lint/test execution run as separate tox environments instead of a combined invocation. Sequence diagram for updated ansible-lint CI workflowsequenceDiagram
participant GitHubActionsRunner as GitHubActionsRunner
participant Pip as pip3
participant Tox as tox
participant ToxLsr as tox_lsr_3_18_1
participant AnsibleLintEnv as ansible_lint_collection_env
GitHubActionsRunner->>Pip: install tox and tox_lsr_3_18_1
Pip-->>GitHubActionsRunner: tox and tox_lsr_3_18_1 installed
GitHubActionsRunner->>GitHubActionsRunner: setup Python matrix.versions.python
GitHubActionsRunner->>Tox: run environment collection
Tox->>ToxLsr: convert role to collection format
ToxLsr-->>Tox: collection layout prepared
Tox-->>GitHubActionsRunner: collection environment complete
GitHubActionsRunner->>Tox: run environment ansible-lint-collection
Tox->>AnsibleLintEnv: set LSR_ANSIBLE_LINT_DEP ansible-lint==matrix.versions.ansible_lint
Tox->>AnsibleLintEnv: set LSR_ANSIBLE_LINT_ANSIBLE_DEP ansible-core==matrix.versions.ansible
Tox->>AnsibleLintEnv: use basepython python{matrix.versions.python}
AnsibleLintEnv-->>GitHubActionsRunner: ansible-lint results
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- In the workflows where you
pip3 installtox-lsr beforeactions/setup-python, consider installing with the matrix Python (e.g. after setup usingpython -m pip) to avoid mixing system Python with the version used by tox and the tests. - Since the tox-lsr version is now repeated across multiple workflows, consider centralizing it via a workflow env variable or a reusable workflow input to reduce the risk of future version drift between CI jobs.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the workflows where you `pip3 install` tox-lsr before `actions/setup-python`, consider installing with the matrix Python (e.g. after setup using `python -m pip`) to avoid mixing system Python with the version used by tox and the tests.
- Since the tox-lsr version is now repeated across multiple workflows, consider centralizing it via a workflow env variable or a reusable workflow input to reduce the risk of future version drift between CI jobs.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 release and separate collection conversion from lint/test execution.
CI: