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

updated README

Browse Source
This commit is contained in:
Klaus Zerwes 2022-08-05 21:50:37 +02:00
parent fface6eae0
commit 245fc0c91b
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -3,10 +3,12 @@
# ansible-fqcn-converter
ansible fqcn converter: update ansible tasks, playbooks etc. to use fully qualified collection name in playbooks (even for ansible buildins)
## usage
```
usage: fqcn-fixer.py [-h] [-d DIRECTORY] [-e FILEEXTENSIONS [FILEEXTENSIONS ...]] [--exclude EXCLUDE_PATHS [EXCLUDE_PATHS ...]]
[-c CONFIG] [-w] [-b BACKUPEXTENSION] [-x]
[-c CONFIG] [-w] [-b BACKUPEXTENSION] [-x] [-m FQCNMAPFILE] [-u]
simple script to fix the fqcn module names
@ -24,12 +26,20 @@ optional arguments:
-b BACKUPEXTENSION, --backup-extension BACKUPEXTENSION
backup extension to use (default: .bak)
-x, --no-diff do not print a diff after parsing a file (default: print it)
-m FQCNMAPFILE, --fqcn-map-file FQCNMAPFILE
yaml file to use for the fqcn map (default: /home/zerwes/git/ansible-fqcn-converter/fqcn.yml)
-u, --update-fqcn-map-file
update the fqcn-map-file
```
## notes
### collections
the scripts uses all collections installed (in the current directory) to build a translation map
The script uses all collections installed (in the current directory) to build a translation map (aka. `fqcn-map-file`).
If the file is not found (or `--update-fqcn-map-file` is in use), the file defined by `--fqcn-map-file` will be created.
| :warning: | this wounds time |
|---------------|:----------------------|
### exclude paths
you can use a `.ansible-lint` config file as input to `-c` in order to define `EXCLUDE_PATHS`
You can use a `.ansible-lint` config file as input to `-c` in order to define `EXCLUDE_PATHS`