ci: ansible-lint requires dependencies to be installed [citest_skip]#286
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>
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdate 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 workflowflowchart 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]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
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
needsdependencies (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 ofcollection→ansible-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`.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 newer tox-lsr release and split Ansible collection conversion from lint/test execution.
CI: