Skip to content

feat: collections README.md update #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 25, 2023
Merged

feat: collections README.md update #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4bd1514
feat: collections `README.md` update
jackhodgkiss Oct 25, 2023
2447055
fix: url to `kayobe-automation`
jackhodgkiss Oct 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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-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.