Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for syntax-check[unknown-module] #4049

Merged
merged 1 commit into from
Feb 26, 2024
Merged

Update documentation for syntax-check[unknown-module] #4049

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/ansiblelint/rules/syntax_check.md
View file
Open in desktop
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
Loading