Table of contents
Thank you very much for making time to improve this Ansible role.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Contributor Code of Conduct.
-
Fork the repo
-
Create a branch and apply your changes to this branch.
a. Make sure you have updated the documentation when adding new variables;
b. Don't forget to add/update tests so we can test the functionality during each Pull Request;
c. Make sure the tests succeed.
-
Push the branch to your fork and submit a pull request.
Note
Pull Requests that fail during the tests will not be merged.
Style guides are important because they ensure consistency in the content, look, and feel of a book or a website.
- Ansible Style Guide
- It's "Ansible" when referring to the product and
ansible
when referring to the command line tool, package, etc - Playbooks should be written in multi-line YAML with
key: value
. The formkey=value
is only foransible
ad-hoc, not foransible-playbook
. - Tasks should always have a
name:
This role makes use of Molecule to test the execution of the role and verify it. In the root of the repository https://github.com/dj-wasabi/ansible-ci-base, a file named requirements.txt
exists and contains the versions used by the tests.
You can install them with the following command:
pip install -r requirements.txt
Once the dependencies are installed, please install Docker as Molecule is configured in this repository to create Docker containers. See this link to install Docker on your system.
Once everything is installed, you can validate your changes by executing:
molecule test
It should run without any issues.
Suggestion is to create a virtualenv so you won't have issues with other projects.
Some web pages describing virtualenvs:
- http://thepythonguru.com/python-virtualenv-guide/
- https://realpython.com/python-virtual-environments-a-primer/
- https://www.dabapps.com/blog/introduction-to-pip-and-virtualenv-python/
Molecule V2 with your own role
End note: Have fun making changes. If a feature helps you, then others find it helpful too and I will happily have it merged.