ci: ansible-lint requires dependencies to be installed [citest_skip]#215
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 to run collection conversion and testing in separate tox invocations, ensuring required collection dependencies are installed before linting/testing. Sequence diagram for updated ansible-lint CI workflowsequenceDiagram
actor Developer
participant GitHubActions as GitHub_Actions
participant Runner as CI_Runner
participant tox as tox
participant toxlsr as tox_lsr_3_18_1
Developer->>GitHubActions: Push or open_pull_request
GitHubActions->>Runner: Start ansible_lint_workflow
Runner->>Runner: Checkout repository
Runner->>toxlsr: pip_install tox_lsr_3_18_1
toxlsr-->>Runner: tox_lsr_3_18_1_installed
Runner->>Runner: setup_python matrix_python_version
Runner->>tox: tox -e collection
tox-->>Runner: collection_built_with_dependencies
Runner->>tox: tox -e ansible_lint_collection
activate LSR_ansible_lint_env_vars
note over Runner, tox: LSR_ANSIBLE_LINT_DEP and LSR_ANSIBLE_LINT_ANSIBLE_DEP exported
tox-->>Runner: ansible_lint_results
Runner-->>GitHubActions: Job_status
GitHubActions-->>Developer: Report_lint_status
Flow diagram for separate collection and test steps in ansible-test workflowflowchart TD
S[Start ansible_test_workflow] --> C1[Checkout repository]
C1 --> P1[Install tox_lsr_3_18_1]
P1 --> PY[Setup matrix_python_version]
PY --> COL[tox -e collection
convert_role_to_collection_format
install_collection_dependencies]
COL --> TEST[tox -e ansible_test_collection
run_ansible_test_on_collection]
TEST --> R[Report test_results]
R --> E[End]
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:
- The tox-lsr version string and the separate
tox -e collectionsteps are now duplicated across multiple workflows; consider factoring the version into a shared env/variable or a reusable workflow to keep these CI definitions DRY and easier to update.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The tox-lsr version string and the separate `tox -e collection` steps are now duplicated across multiple workflows; consider factoring the version into a shared env/variable or a reusable workflow to keep these CI definitions DRY and easier to update.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 and separate collection build from lint/test execution.
CI: