a85bd39738
##### SUMMARY As a part of the [Consolidating Ansible discussion platforms initiative](https://forum.ansible.com/t/proposal-consolidating-ansible-discussion-platforms/6812), this PR adds the communication section template defined by the community to the README. Similar PRs are being raised across all included collections under the ansible-collection org for now. - If you have your forum group and/or tags related to the collection, please update corresponding lines by suggesting changes to the PR. - If the collection is not present on the Ansible forum yet, please check out the existing [tags](https://forum.ansible.com/tags) and [groups](https://forum.ansible.com/g) - use what suits your collection. If there is no appropriate tag, please [request one](https://forum.ansible.com/t/requesting-a-forum-group/503/17). You can also request a group there as a WG if needed. Then update corresponding lines by suggesting changes to the PR. - Presence in the forum will soon likely become a part of the Collection inclusion requirements. ##### ISSUE TYPE - Docs Pull Request ##### COMPONENT NAME README.md --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: jo <ljonas@riseup.net>
3.9 KiB
Ansible Collection: hetzner.hcloud
Ansible Hetzner Cloud Collection for controlling your Hetzner Cloud Resources.
Communication
-
Join the Ansible forum:
- Get Help: get help or help others.
- Posts tagged with 'hcloud': subscribe to participate in collection-related conversations.
- Social Spaces: gather and interact with fellow enthusiasts.
- News & Announcements: track project-wide announcements including social events.
-
The Ansible Bullhorn newsletter: used to announce releases and important changes.
For more information about communication, see the Ansible communication guide.
Python version compatibility
This collection depends on the hcloud library. Due to the hcloud Python Support Policy this collection requires Python 3.8 or greater.
Release notes
See here.
Release policy
The main branch is used for the development of the latest versions of the collections, and may contain breaking changes. The stable-* branches (e.g. stable-1 for the 1.x.y releases) are used to cut additional minor or patch releases if needed, but we do not provide official support for multiple versions of the collection.
Documentation
The documentation for all modules are available through ansible-doc.
Sample: ansible-doc hetzner.hcloud.server shows the documentation for the server module.
For all modules that were part of Ansible directly (before Ansible 2.11) we also have the documentation published in the Ansible documentation: https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/
Development
Requirements
You should place the collection (clone the repository) into the Ansible collection path. Normally this
is ~/.ansible/collections/ansible_collections/<namespace>/<collection, so for our collection it would
be: ~/.ansible/collections/ansible_collections/hetzner/hcloud.
git clone git@github.com:ansible-collections/hetzner.hcloud.git ~/.ansible/collections/ansible_collections/hetzner/hcloud
After this you just need ansible installed.
Testing
Testing is done via ansible-test. Make sure to have a cloud-config-hcloud.ini file in tests/integration which
contains the hcloud API token:
[default]
hcloud_api_token=<token>
After this you should be able to use ansible-test integration to perform the integration tests for a specific module.
Sample:
ansible-test integration --color --local -vvv hetzner.hcloud.server // Executed all integration tests for server module
Releasing a new version
If there are releasable changes, release-please will open a PR on GitHub with the proposed version. When this PR is merged, release-please will tag the release.