Skip to content

Commit

Permalink
Document valid locations for requirements.yml in the docs (#4134)
Browse files Browse the repository at this point in the history
  • Loading branch information
shatakshiiii committed May 6, 2024
1 parent 262c02c commit 69b6c58
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/ansiblelint/rules/syntax_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,17 @@ installed. You must ensure that all collections and roles used inside your
repository are listed inside a [`requirements.yml`](https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#installing-roles-and-collections-from-the-same-requirements-yml-file) file, so the linter can
install them when they are missing.

Valid location for `requirements.yml` are:

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

Note: If requirements are test related then they should be inside `tests/`.

## Problematic code

```yaml
Expand Down

0 comments on commit 69b6c58

Please sign in to comment.