https://github.com/stackhpc/collectionise-all-the-things
Add standalone Ansible roles to collections
https://github.com/stackhpc/collectionise-all-the-things
Last synced: 2 months ago
JSON representation
Add standalone Ansible roles to collections
- Host: GitHub
- URL: https://github.com/stackhpc/collectionise-all-the-things
- Owner: stackhpc
- License: apache-2.0
- Created: 2023-11-24T11:00:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-28T13:35:16.000Z (over 2 years ago)
- Last Synced: 2024-04-14T22:50:19.062Z (over 2 years ago)
- Language: Shell
- Size: 10.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Collectionise all the things
Utilities to help adding standalone Ansible roles to collections.
## HOWTO
* Check for any open PRs or issues in the role.
* Choose a name for the role in the collection. It cannot include dashes (`-`)
* Clone the target collection
* Clone the role to be added
* Clone this repository next to your collection
* Change to the collection root directory
* Create a new branch for the change
* Add the role content:
```sh
../collectionise-all-the-things/collectionise.sh
```
* Run sanity tests, fix issues and commit changes:
```sh
../collectionise-all-the-things/collection-sanity.sh
```
* Run ansible-lint in auto-fix mode:
```sh
ansible-lint --fix
```
* Inspect changes, adapt and commit.
* Fix any remaining ansible-lint issues and commit.
* Inspect the role for any other changes, modernisation, etc.
* Update the role's README.
* Add the role to the list of roles in the collection's main README.
* Check sanity tests and ansible-lint again.
* Test the role.
* Create a PR.
* Mark the role as deprecated, and archive the repository.