Skip to content

Latest commit

 

History

History
16 lines (11 loc) · 1.41 KB

TEMPLATE.md

File metadata and controls

16 lines (11 loc) · 1.41 KB
Raw

Ansible Role Template

This is a repository template for Ansible roles. See GitHub's documentation on how to create a repository from a template.

This template runs tests using Ansible Molecule. Automated tests have been configured to run on GitHub actions in the .github/workflows/ci.yml file. The Docker Molecule driver is used to run the tests. The following pip packages are required (if you were to run Ansible Molecule locally):

  1. molecule 3.x.x (Install by running pip install "molecule>=3,<4")
  2. docker-py

After you create your repository from this template:

  1. Replace all occurrences of "ansible-role" with the name of your role. If your role is, for instance, called "ansible-superset", make the change using find . -type f | xargs sed -i 's/ansible-role/ansible-superset/g'.
  2. Set the ansible_galaxy_api_key secret in your repository's settings to enable publishing tags to Ansible Galaxy.
  3. Update the owner and date in the LICENSE file.
  4. Update the value of role_name, min_ansible_version, supported platforms, and description in meta/main.yml. In the example, set role_name to "superset", if you intend for the role to be "onaio.superset" within Ansible Galaxy.
  5. Fill in the sections within the README.md file.