ToDo: Document more things
PiCli is a python client for PiedPiper, a CI-pipeline validation framework.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Python 3.6 (Optionally) virtualenv PiedPiper OpenFaaS functions installed. ToDo: Document installation of OpenFaaS + functions
docker build -t picli .
docker run -it picli /bin/sh
pip install -r requirements.txt
python setup.py install
To run PiCli:
picli --config path/to/your/repo/piedpier.d/pi_global_vars.yml lint
picli --config path/to/your/repo/piedpier.d/pi_global_vars.yml validate
debug
picli --debug validate
Debug will dump PiCli's run_vars to the screen during execution. This allows the user to validate PiCli's configuration that is being sent to the various functions.
Currently we just have functional tests. These require an OpenFaaS installation. The test script can be found in tests/functional/run-tests.sh
Add additional notes about how to deploy this on a live system
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
See also the list of contributors who participated in this project.
TBD
- Inspiration for the CLI framework came from the Ansible Molecule project