Skip to content

Commit

Permalink
Update documentation for syntax-check[unknown-module] (#4049)
Browse files Browse the repository at this point in the history
  • Loading branch information
ssbarnea authored Feb 26, 2024
1 parent 482aba3 commit efeda67
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/ansiblelint/rules/syntax_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ This rule can produce messages like:
- `syntax-check[unknown-module]`: couldn't resolve module/action
- `syntax-check[specific]`: for other errors not mentioned above.

## syntax-check[unknown-module]

The linter relies on ansible-core code to load the ansible code and it will
produce a syntax error if the code refers to ansible content that is not
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.

## Problematic code

```yaml
Expand Down

0 comments on commit efeda67

Please sign in to comment.