diff --git a/README.md b/README.md index 30322c2..e769c2f 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,6 @@ This script loads input from: - molecule/default/prepare.yml - molecule/default/playbook.yml* - molecule/default/verify.yml -- meta/logo.png - generate_modules.sh - Ansible Galaxy diff --git a/generate.yml b/generate.yml index 7354097..970c9b2 100755 --- a/generate.yml +++ b/generate.yml @@ -44,11 +44,6 @@ when: - exceptionymlstat.stat.exists | bool - - name: check meta/logo.png - stat: - path: "{{ role_path }}/meta/logo.png" - register: logo - - name: check meta/preferences.yml stat: path: "{{ role_path }}/meta/preferences.yml" diff --git a/templates/README.md.j2 b/templates/README.md.j2 index baed693..0726344 100644 --- a/templates/README.md.j2 +++ b/templates/README.md.j2 @@ -1,22 +1,20 @@ {{ role_name }} ========= -Ansible logo{% if logo.stat.exists %}Project logo{% endif %} - - Build status - - - {{ meta.galaxy_info.description }} +|Travis|GitHub|Quality|Downloads| +|------|------|-------|---------| +|[![travis](https://travis-ci.org/{{ travis_namespace }}/ansible-role-{{ role_name }}.svg?branch=master)](https://travis-ci.org/{{ travis_namespace }}/ansible-role-{{ role_name }})|[![github](https://github.com/{{ github_namespace }}/ansible-role-{{ role_name }}/workflows/Ansible%20Molecule/badge.svg)](https://github.com/{{ github_namespace }}/ansible-role-{{ role_name }}/actions)|![quality](https://img.shields.io/ansible/quality/{{ galaxy_id.stdout }})|![downloads](https://img.shields.io/ansible/role/d/{{ galaxy_id.stdout }})| + Example Playbook ---------------- -This example is taken from `molecule/resources/playbook.yml` and is tested on each push, pull request and release. +This example is taken from `molecule/resources/converge.yml` and is tested on each push, pull request and release. ```yaml {{ example.content | b64decode | regex_replace('ansible-role-', galaxy_namespace ~ '.') }}``` -The machine you are running this on, may need to be prepared, I use this playbook to ensure everything is in place to let the role work. +The machine may need to be prepared using `molecule/resources/prepare.yml`: ```yaml {% if prepare.content is defined %} {{ prepare.content | b64decode | regex_replace('ansible-role-', galaxy_namespace ~ '.') }}``` @@ -26,7 +24,7 @@ No preparation required. {% endif %} {% if verifyyml.content is defined %} -After running this role, this playbook runs to verify that everything works, this may be a good example how you can use this role. +For verification `molecule/resources/verify.yml` run after the role has been applied. ```yaml {{ verifyyml.content | b64decode | regex_replace('ansible-role-', galaxy_namespace ~ '.') }}``` {% endif %}