github
/
ansible-later
mirror of https://github.com/thegeeklab/ansible-later.git
0
0
Fork 0
Code Issues Projects Releases Wiki Activity

prepare readme refactoring

This commit is contained in:
Robert Kaussow 2019-04-10 16:17:52 +02:00
parent bdeded30f2
commit a727c6e983
1 changed files with 34 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
README.md
View File

@ -13,28 +13,27 @@ for his work on ansible-review and ansible-lint.
it helps to have a coding or best practice guideline in place. This will make ansible roles more readable for all it helps to have a coding or best practice guideline in place. This will make ansible roles more readable for all
maintainers and can reduce the troubleshooting time. maintainers and can reduce the troubleshooting time.
`ansible-later` does _**not**_ ensure that your role will work as expected. `ansible-later` does _**not**_ ensure that your role will work as expected. For Deployment test you can use other tools
like [molecule](https://github.com/ansible/molecule).
The project name is an acronym for **L**ovely **A**utomation **TE**sting f**R**mework. The project name is an acronym for **L**ovely **A**utomation **TE**sting f**R**mework.
## Table of Content ## Table of Content
- [ansible-later](#ansible-later) - [Setup](#setup)
- [Table of Content](#table-of-content) - [Using pip](#using-pip)
- [Setup](#setup) - [From source](#from-source)
- [Using pip](#using-pip) - [Configuration](#configuration)
- [From source](#from-source) - [Usage](#usage)
- [Usage](#usage) - [Review a git repositories](#review-a-git-repositories)
- [Configuration](#configuration) - [Review a list of files](#review-a-list-of-files)
- [Review a git repositories](#review-a-git-repositories) - [Buildin rules](#buildin-rules)
- [Review a list of files](#review-a-list-of-files) - [Build your own](#build-your-own)
- [Buildin rules](#buildin-rules) - [The standards file](#the-standards-file)
- [Build your own](#build-your-own) - [Candidates](#candidates)
- [The standards file](#the-standards-file) - [Minimal standards checks](#minimal-standards-checks)
- [Candidates](#candidates) - [License](#license)
- [Minimal standards checks](#minimal-standards-checks) - [Maintainers and Contributors](#maintainers-and-contributors)
- [License](#license)
- [Maintainers and Contributors](#maintainers-and-contributors)
--- ---
@ -59,14 +58,30 @@ export PYTHONPATH=$PYTHONPATH:`pwd`/ansible-later/ansiblelater
export PATH=$PATH:`pwd`/ansible-later/ansiblelater/bin export PATH=$PATH:`pwd`/ansible-later/ansiblelater/bin
``` ```
### Configuration
If your standards (and optionally inhouse rules) are set up, create
a configuration file in the appropriate location (this will depend on
your operating system)
The location can be found by using `ansible-later` with no arguments.
You can override the configuration file location with the `-c` flag.
```INI
[rules]
standards = /path/to/your/standards/rules
```
The standards directory can be overridden with the `-d` argument.
### Usage ### Usage
```Shell ```Shell
ansible-later FILES ansible-later FILES
``` ```
Where FILES is a space delimited list of files to review. Where FILES is a space delimited list of files to review. ansible-later is _not_ recursive and won't descend
ansible-later is _not_ recursive and won't descend
into child folders; it just processes the list of files you give it. into child folders; it just processes the list of files you give it.
Passing a folder in with the list of files will elicit a warning: Passing a folder in with the list of files will elicit a warning:
@ -93,23 +108,6 @@ files, python code (modules, plugins) 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
#### Configuration
If your standards (and optionally inhouse rules) are set up, create
a configuration file in the appropriate location (this will depend on
your operating system)
The location can be found by using `ansible-later` with no arguments.
You can override the configuration file location with the `-c` flag.
```INI
[rules]
standards = /path/to/your/standards/rules
```
The standards directory can be overridden with the `-d` argument.
#### Review a git repositories #### Review a git repositories
- `git ls-files | xargs ansible-later` works well in - `git ls-files | xargs ansible-later` works well in