small adjustments
This commit is contained in:
parent
925ae5c515
commit
c4b2e1e945
37
README.md
37
README.md
|
@ -25,9 +25,10 @@ The project name is an acronym for **L**ovely **A**utomation **TE**sting f**R**m
|
||||||
- [From source](#from-source)
|
- [From source](#from-source)
|
||||||
- [Configuration](#configuration)
|
- [Configuration](#configuration)
|
||||||
- [Default settings](#default-settings)
|
- [Default settings](#default-settings)
|
||||||
|
- [CLI Options](#cli-options)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
- [Buildin rules](#buildin-rules)
|
- [Buildin rules](#buildin-rules)
|
||||||
- [Build your own](#build-your-own)
|
- [Build your own rules](#build-your-own-rules)
|
||||||
- [The standards file](#the-standards-file)
|
- [The standards file](#the-standards-file)
|
||||||
- [Candidates](#candidates)
|
- [Candidates](#candidates)
|
||||||
- [Minimal standards checks](#minimal-standards-checks)
|
- [Minimal standards checks](#minimal-standards-checks)
|
||||||
|
@ -133,6 +134,34 @@ yamllint:
|
||||||
spaces: 2
|
spaces: 2
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### CLI Options
|
||||||
|
|
||||||
|
You can get all available cli options by running `ansible-later --help`:
|
||||||
|
|
||||||
|
```Shell
|
||||||
|
$ ansible-later --help
|
||||||
|
usage: ansible-later [-h] [-c CONFIG_FILE] [-r RULES.STANDARDS]
|
||||||
|
[-s RULES.FILTER] [-v] [-q] [--version]
|
||||||
|
[rules.files [rules.files ...]]
|
||||||
|
|
||||||
|
Validate ansible files against best pratice guideline
|
||||||
|
|
||||||
|
positional arguments:
|
||||||
|
rules.files
|
||||||
|
|
||||||
|
optional arguments:
|
||||||
|
-h, --help show this help message and exit
|
||||||
|
-c CONFIG_FILE, --config CONFIG_FILE
|
||||||
|
location of configuration file
|
||||||
|
-r RULES.STANDARDS, --rules RULES.STANDARDS
|
||||||
|
location of standards rules
|
||||||
|
-s RULES.FILTER, --standards RULES.FILTER
|
||||||
|
limit standards to specific ID's
|
||||||
|
-v increase log level
|
||||||
|
-q decrease log level
|
||||||
|
--version show program's version number and exit
|
||||||
|
```
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
```Shell
|
```Shell
|
||||||
|
@ -164,7 +193,7 @@ and playbooks.
|
||||||
- per-playbook repository
|
- per-playbook repository
|
||||||
- It should work with roles requirement files and with local roles
|
- It should work with roles requirement files and with local roles
|
||||||
|
|
||||||
#### Buildin rules
|
### Buildin rules
|
||||||
|
|
||||||
Reviews are nothing without some rules or standards against which to review. ansible-later
|
Reviews are nothing without some rules or standards against which to review. ansible-later
|
||||||
comes with a couple of built-in checks explained in the following table.
|
comes with a couple of built-in checks explained in the following table.
|
||||||
|
@ -196,7 +225,7 @@ comes with a couple of built-in checks explained in the following table.
|
||||||
| check_become_user | ANSIBLE0015 | `become` should be always used combined with `become_user`. | |
|
| check_become_user | ANSIBLE0015 | `become` should be always used combined with `become_user`. | |
|
||||||
| check_filter_separation | ANSIBLE0016 | Jinja2 filters should be separated with spaces. | |
|
| check_filter_separation | ANSIBLE0016 | Jinja2 filters should be separated with spaces. | |
|
||||||
|
|
||||||
### Build your own
|
### Build your own rules
|
||||||
|
|
||||||
#### The standards file
|
#### The standards file
|
||||||
|
|
||||||
|
|
|
@ -16,15 +16,15 @@ def main():
|
||||||
parser = argparse.ArgumentParser(
|
parser = argparse.ArgumentParser(
|
||||||
description="Validate ansible files against best pratice guideline")
|
description="Validate ansible files against best pratice guideline")
|
||||||
parser.add_argument("-c", "--config", dest="config_file",
|
parser.add_argument("-c", "--config", dest="config_file",
|
||||||
help="Location of configuration file")
|
help="location of configuration file")
|
||||||
parser.add_argument("-r", "--rules", dest="rules.standards",
|
parser.add_argument("-r", "--rules", dest="rules.standards",
|
||||||
help="Location of standards rules")
|
help="location of standards rules")
|
||||||
parser.add_argument("-q", "--quiet", dest="logging.level", action="append_const",
|
|
||||||
const=1, help="Only output errors")
|
|
||||||
parser.add_argument("-s", "--standards", dest="rules.filter", action="append",
|
parser.add_argument("-s", "--standards", dest="rules.filter", action="append",
|
||||||
help="limit standards to specific names")
|
help="limit standards to specific ID's")
|
||||||
parser.add_argument("-v", dest="logging.level", action="append_const", const=-1,
|
parser.add_argument("-v", dest="logging.level", action="append_const", const=-1,
|
||||||
help="Show more verbose output")
|
help="increase log level")
|
||||||
|
parser.add_argument("-q", dest="logging.level", action="append_const",
|
||||||
|
const=1, help="decrease log level")
|
||||||
parser.add_argument("rules.files", nargs="*")
|
parser.add_argument("rules.files", nargs="*")
|
||||||
parser.add_argument("--version", action="version", version="%(prog)s {}".format(__version__))
|
parser.add_argument("--version", action="version", version="%(prog)s {}".format(__version__))
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue