Fix and document installing of requirements.yml files

Related: ansible/ansible-compat#275 Related: ansible-community/community-topics#230
ansible · May 21, 2023 · a75df46 · a75df46
1 parent ab18405
commit a75df46
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/.projects/ansible-compat b/.projects/ansible-compat
diff --git a/docs/usage.md b/docs/usage.md
@@ -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
@@ -318,3 +318,17 @@ 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`](https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#installing-roles-and-collections-from-the-same-requirements-yml-file)
+- `roles/requirements.yml`
+- `collections/requirements.yml`
+- `tests/requirements.yml`
+- `tests/integration/requirements.yml`
+- `tests/unit/requirements.yml`
+- [`galaxy.yml`](https://docs.ansible.com/ansible/latest/dev_guide/collections_galaxy_meta.html)
+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