Skip to content

Commit

Permalink
Update readme with limitations
Browse files Browse the repository at this point in the history
  • Loading branch information
hoo29 committed Oct 13, 2024
1 parent c609a52 commit c7f204b
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,26 @@ little-timmy
python3 -m little_timmy
```

Little Timmy can find the "80%" of unused variables but due to the numerous ways variables can be declared and consumed in Ansible, some will be missed.
Little Timmy can find the "80%" of unused variables but due to the numerous ways variables can be declared
and consumed in Ansible, some will be missed.

It should find unused variables in:

- `group_vars`
- `host_vars`
- `vars`
- `defaults`
- Inventory files

The above files are parsed to find variable declarations followed by a rudimentary search for their usage in
playbooks, templates, tasks, and handler files.

It will not find unused variables for:

- `set_facts`
- `register`
- Dynamically created or referenced variables
- Variables consumed in any custom python filters or similar

## Github Action

Expand Down

0 comments on commit c7f204b

Please sign in to comment.