From c792677f2b691023b85b604f6af6fc9749c1d3f0 Mon Sep 17 00:00:00 2001 From: Sorin Sbarnea Date: Fri, 16 Aug 2024 12:43:19 +0100 Subject: [PATCH] Few more fixes --- README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 0f21dc7a..62f250f8 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,18 @@ This collection contains event source plugins, event filters and example rulebooks to be used with [ansible-rulebook](https://ansible-rulebook.readthedocs.io/en/stable/). - +[![tox](https://github.com/ansible/event-driven-ansible/actions/workflows/tox.yml/badge.svg?event=push)](https://github.com/ansible/event-driven-ansible/actions/workflows/tox.yml) +[![codecov](https://codecov.io/github/ansible/event-driven-ansible/graph/badge.svg?token=XvFwDpezAH)](https://codecov.io/github/ansible/event-driven-ansible) ## Description -The primary purpose of this collection is to to reduce manual tasks and deliver more efficient mission-critical workflows. By leveraging this collection, organizations can automate a variety of error-prone and time-consuming tasks and respond to changing conditions in any IT domain across IT environments for better agility and resiliency. +The primary purpose of this collection is to reduce manual tasks and deliver more efficient mission-critical workflows. By leveraging this collection, organizations can automate a variety of error-prone and time-consuming tasks and respond to changing conditions in any IT domain across IT environments for better agility and resiliency. ## Requirements ### Ansible version compatibility -Tested with the Ansible Core >= 2.15.0 versions, and the current development version of Ansible. Ansible Core versions prior to 2.15.0 are not supported. +Tested with the Ansible Core >= 2.15.0 versions, and the current development version of Ansible. Ansible Core versions before 2.15.0 are not supported. ### Python version compatibility @@ -24,7 +25,7 @@ This collection requires ansible-rulebook 1.0.0 or greater. ## Installation -The ansible.eda collection can be installed with Ansible Galaxy command-line tool: +The `ansible.eda` collection can be installed with the Ansible Galaxy command-line tool: ```shell ansible-galaxy collection install ansible.eda @@ -41,7 +42,7 @@ collections: Note that if you install any collections from Ansible Galaxy, they will not be upgraded automatically when you upgrade the Ansible package. To upgrade the collection to the latest available version, run the following command: -``` +```shell ansible-galaxy collection install ansible.eda --upgrade ``` @@ -56,24 +57,24 @@ collections: or using the ansible-galaxy command as follows -``` +```shell ansible-galaxy collection install ansible.eda:==1.0.0 ``` -The python module dependencies are not installed by ansible-galaxy. They must be installed manually using pip: +The Python module dependencies are not installed by ansible-galaxy. They must be installed manually using pip: ```shell pip install -r requirements.txt ``` -Refer the following for more details. +Refer to the following for more details. * [using Ansible collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details. ## Use Cases -You can either call modules, rulebooks and playbook by their Fully Qualified Collection Name (FQCN), such as ansible.eda.activation, or you can call modules by their short name if you list the ansible.eda collection in the playbook's collections keyword: +You can either call modules, rulebooks and playbooks by their Fully Qualified Collection Name (FQCN), such as ansible.eda.activation, or you can call modules by their short name if you list the ansible.eda collection in the playbook's collections keyword: -``` +```yaml --- - name: Create a rulebook activation ansible.eda.activation: @@ -111,11 +112,11 @@ See the [raw generated changelog](https://github.com/ansible/event-driven-ansibl ## Related Information -- [Ansible Collection overview](https://github.com/ansible-collections/overview) -- [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html) -- [Ansible Developer guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html) +- [Ansible Collection Overview](https://github.com/ansible-collections/overview) +- [Ansible User Guide](https://docs.ansible.com/ansible/latest/user_guide/index.html) +- [Ansible Developer Guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html) - [Ansible Collection Developer Guide](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html) -- [Ansible Community code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) +- [Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) ## License Information