IntenseWebs/ansible-fqcn-converter
3
0
Fork 0
mirror of https://github.com/zerwes/ansible-fqcn-converter.git synced 2025-02-16 16:14:50 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc ambiguous replacements behavior better

Browse Source
This commit is contained in:
Klaus Zerwes 2022-09-20 07:51:30 +02:00
parent 000bdd38f9
commit f1b8aeafaf
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -3,7 +3,17 @@
# Ansible FQCN converter
Update ansible tasks, playbooks, handlers etc. to use fully qualified module names (even for ansible buildins) by searching for all known modules that are not in fqcn notation and replacing them with the fqcn name.
In some cases the replacement might be ambiguous, so a warning will be printed (and by default added as a comment to the changed files).
In some cases the replacement might be ambiguous, so a warning will be issued (and by default added as a comment to the changed files; see `-W` arg).
Ansible native modules (`ansible.builtin`, `ansible.posix `ansible.utils`, ...) will have precedence on ambiguous module names.
Example diff:
```diff
- name: test user ... expect buildin
- user:
+ # possible ambiguous replacement: user : ansible.builtin.user | awx.awx.user | inspur.sm.user | sensu.sensu_go.user | theforeman.foreman.user
+ ansible.builtin.user:
name: test
password: '!'
```
Tha ansible files should be linted and valid yaml files. Esp. the following ansible-lint tags should be covered:
- no-tabs