From 4bd1514540b43b5c33044f563cd9121578f08ebd Mon Sep 17 00:00:00 2001 From: Jack Hodgkiss Date: Wed, 25 Oct 2023 13:21:31 +0100 Subject: [PATCH 1/2] feat: collections `README.md` update --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 91b09e7..eaf3829 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ -# Ansible Collection - stackhpc.kayobe_automation_workflows +# Ansible Collection - stackhpc.kayobe_workflows -Documentation for the collection. +This repository contains `stackhpc.kayobe_workflows` an Ansible Collection. The collection currently includes a role for generating workflows that utilise [stackhpc/kayobe-workflows](https://github.com/stackhpc/kayobe-automation)https://github.com/stackhpc/kayobe-automation within GitHub Actions. + +## Included content + +Roles: +* [github](roles/github/README.md) for generating workflows appropriate for GitHub Actions + +## Using this collection + +Before using the collection, you need to install the collection with the `ansible-galaxy` CLI: + + ansible-galaxy collection install stackhpc.kayobe_workflows + +You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml` using the format: + +```yaml +collections: +- name: stackhpc.kayobe_workflows +``` + +See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details. From 244705530f4992d1ef556c60c27deabb9c74faa6 Mon Sep 17 00:00:00 2001 From: Jack Hodgkiss Date: Wed, 25 Oct 2023 13:41:09 +0100 Subject: [PATCH 2/2] fix: url to `kayobe-automation` Co-authored-by: Mark Goddard --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index eaf3829..2a754e4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Ansible Collection - stackhpc.kayobe_workflows -This repository contains `stackhpc.kayobe_workflows` an Ansible Collection. The collection currently includes a role for generating workflows that utilise [stackhpc/kayobe-workflows](https://github.com/stackhpc/kayobe-automation)https://github.com/stackhpc/kayobe-automation within GitHub Actions. +This repository contains `stackhpc.kayobe_workflows` an Ansible Collection. The collection currently includes a role for generating workflows that utilise [stackhpc/kayobe-automation](https://github.com/stackhpc/kayobe-automation) within GitHub Actions. ## Included content