ci: ansible-lint requires dependencies to be installed [citest_skip]#498
Merged
ci: ansible-lint requires dependencies to be installed [citest_skip]#498
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 the collection build step runs separately from the lint/test steps, ensuring required Ansible collection dependencies are installed before running. Sequence diagram for separated collection build and ansible-lint steps in CIsequenceDiagram
participant GitHubActionsRunner
participant tox
participant tox_lsr_3_18_1
participant CollectionEnv as tox_env_collection
participant LintEnv as tox_env_ansible_lint_collection
participant ansible_lint
participant ansible_core
GitHubActionsRunner->>GitHubActionsRunner: Checkout code
GitHubActionsRunner->>GitHubActionsRunner: Setup Python matrix version
GitHubActionsRunner->>tox_lsr_3_18_1: Install tox-lsr 3.18.1 via pip
Note over GitHubActionsRunner,CollectionEnv: Convert role to collection format
GitHubActionsRunner->>tox: Run tox -e collection
tox->>tox_lsr_3_18_1: Resolve env collection
tox_lsr_3_18_1->>CollectionEnv: Create and configure env
CollectionEnv->>CollectionEnv: Build collection
CollectionEnv->>CollectionEnv: Install collection dependencies from meta/collection-requirements.yml
CollectionEnv->>CollectionEnv: Install test dependencies from tests/collection-requirements.yml
Note over GitHubActionsRunner,LintEnv: Run ansible-lint on built collection
GitHubActionsRunner->>tox: Run tox -e ansible-lint-collection
tox->>tox_lsr_3_18_1: Resolve env ansible-lint-collection
tox_lsr_3_18_1->>LintEnv: Create and configure env with Python version
LintEnv->>ansible_core: Install ansible-core==matrix.versions.ansible
LintEnv->>ansible_lint: Install ansible-lint==matrix.versions.ansible_lint
LintEnv->>ansible_lint: Execute ansible-lint against collection
ansible_lint-->>GitHubActionsRunner: Report 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:
- Consider centralizing the tox-lsr version (e.g., as a workflow env var or reusable workflow input) so future version bumps only require a single change instead of updating each workflow separately.
- Since the
collectiontox env is now run as a separate step in multiple workflows, you might factor it into a reusable workflow or composite action to avoid duplication and ensure consistent behavior.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider centralizing the tox-lsr version (e.g., as a workflow env var or reusable workflow input) so future version bumps only require a single change instead of updating each workflow separately.
- Since the `collection` tox env is now run as a separate step in multiple workflows, you might factor it into a reusable workflow or composite action to avoid duplication and ensure consistent behavior.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 split collection conversion from lint/test execution.
CI: