Skip to content

Commit

Permalink
Fix and document installing of requirements.yml files
Browse files Browse the repository at this point in the history 
Related: ansible/ansible-compat#275
Related: ansible-community/community-topics#230
  • Loading branch information
@ssbarnea
ssbarnea committed May 21, 2023
1 parent ab18405 commit cf1e799
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .projects/ansible-compat
Submodule ansible-compat updated 9 files
+1 −0 .github/workflows/tox.yml
+1 −0 .gitignore
+4 −0 examples/reqs_broken/requirements.yml
+5 −1 pyproject.toml
+7 −3 requirements.txt
+10 −0 src/ansible_compat/constants.py
+12 −8 src/ansible_compat/runtime.py
+7 −0 test/test_runtime.py
+14 −3 tox.ini
15 changes: 14 additions & 1 deletion docs/usage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Ansible-lint creates a new cache on the next invocation.
You should add the `.cache` folder to the `.gitignore` file in your git
repositories.

# Gradual adoption
## Gradual adoption

For an easier gradual adoption, adopters should consider [ignore
file][configuring.md#ignoring-rules-for-entire-files] feature. This allows the
Expand Down Expand Up @@ -318,3 +318,16 @@ fully understand [variable precedence].
https://docs.oasis-open.org/sarif/sarif/v2.1.0/csprd01/sarif-v2.1.0-csprd01.html
[variable precedence]:
https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_variables.html#understanding-variable-precedence

## Dependencies and requirements

Ansible-lint will recognize `requirements.yml` files used for runtime and
testing purposes and install them automatically. Valid locations for these files
are:

- `requirements.yml`
- `roles/requirements.yml`
- `collections/requirements.yml`
- `tests/requirements.yml`
- `tests/integration/requirements.yml`
- `tests/unit/requirements.yml`

0 comments on commit cf1e799

Please sign in to comment.