Skip to content

Commit 4bd1514

Browse files
committed
feat: collections README.md update
1 parent d444661 commit 4bd1514

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1-
# Ansible Collection - stackhpc.kayobe_automation_workflows
1+
# Ansible Collection - stackhpc.kayobe_workflows
22

3-
Documentation for the collection.
3+
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.
4+
5+
## Included content
6+
7+
Roles:
8+
* [github](roles/github/README.md) for generating workflows appropriate for GitHub Actions
9+
10+
## Using this collection
11+
12+
Before using the collection, you need to install the collection with the `ansible-galaxy` CLI:
13+
14+
ansible-galaxy collection install stackhpc.kayobe_workflows
15+
16+
You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml` using the format:
17+
18+
```yaml
19+
collections:
20+
- name: stackhpc.kayobe_workflows
21+
```
22+
23+
See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.

0 commit comments

Comments
 (0)