Skeletons to be used to create new Ansible collections and roles.
Creating new Ansible collections and roles requires some boilerplate. The default skeletons are sufficient for small collections, but lack a lot of possibibilities and guidance. As a developer, I want to get started without copy/pasting lots of content from another repository and maintain a common design of collections and roles.
The repository provides skeletons, which can be used from the ansible-galaxy
command to create new collections and roles. For now, the design allows roles
to be created as part of a collection. You can also find lots of documentation
and guidance in the skeletons to get started with your first collection or
role.
We are really happy, that you consider using our software. In case you want to install and run the code on your machine, please check out this section.
The collection and role skeleton are designed to be used with Ansible >= 2.10. Older versions may work, but lack certain features like argument specifications.
To use the skeletons, you need to clone the repository or download a release and unpack it to your desired directory.
# Clone the repository
$ git clone https://github.com/whiletruedoio/ansible-skeleton.gitNow, change to your project directory and create a new collection or role.
# Create a collection
$ ansible-galaxy collection init \
--collection-skeleton /path/to/skeleton/collection collection_name
# Create a role
$ ansible-galaxy role init \
--role-skeleton /path/to/skeleton/role role_nameUnfortunately, there is no easy way to persist this for now. Please check the issue #76643 for more information.
You can also have a look at the upstream documentation for some more detailed information about skeletons.
Thank you so much for considering to contribute! We are happy, when someone is joining the hard work.
Issues and Pull Requests are handled on a regular basis. Please be aware, that we may reach out to you, ask you to provide additional resources or want to discuss the issue a little, before planning it.
Providing code to this repository is pretty straight forward. Open an issue, so we can discuss the bug/feature and start working on it afterwards. You just need to open the pull request afterwards and that's it.
It is also strongly recommended to read the Contribution Guideline beforehand.
We are maintaining a changelog for repositories. Normally, the developers will update the changelog, according to keepachangelog.com.
To ensure a high quality and functionality, we want to carefully test our software. The provided code is automatically tested as described in the .cirrus.yml.
Except otherwise noted, all work is licensed under a BSD-3-Clause License.
Please feel free to reach out to us and the community. We also recommend to read and understand the Code of Conduct beforehand.
- Site: https://while-true-do.io
- Blog: https://blog.while-true-do.io
- Code: https://github.com/whiletruedoio
- Chat: libera.chat #whiletruedoio
- Mail: [email protected]