From 38b7c80217c4e72b1d8988eb1e60bb6e77334114 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Thu, 18 Apr 2024 07:52:22 +0200 Subject: Adding upstream version 9.4.0+dfsg. Signed-off-by: Daniel Baumann --- ansible_collections/hetzner/hcloud/README.md | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) (limited to 'ansible_collections/hetzner/hcloud/README.md') diff --git a/ansible_collections/hetzner/hcloud/README.md b/ansible_collections/hetzner/hcloud/README.md index f57ae7be3..274c90884 100644 --- a/ansible_collections/hetzner/hcloud/README.md +++ b/ansible_collections/hetzner/hcloud/README.md @@ -1,20 +1,29 @@ -[![Build Status](https://dev.azure.com/ansible/hetzner.hcloud/_apis/build/status/CI?branchName=master)](https://dev.azure.com/ansible/hetzner.hcloud/_build?definitionId=35) +[![Galaxy version](https://img.shields.io/badge/dynamic/json?label=galaxy&prefix=v&url=https://galaxy.ansible.com/api/v3/plugin/ansible/content/published/collections/index/hetzner/hcloud/&query=highest_version.version)](https://galaxy.ansible.com/ui/repo/published/hetzner/hcloud) +[![GitHub version](https://img.shields.io/github/v/release/ansible-collections/hetzner.hcloud)](https://github.com/ansible-collections/hetzner.hcloud/releases) +[![Build Status](https://dev.azure.com/ansible/hetzner.hcloud/_apis/build/status/ci?branchName=main)](https://dev.azure.com/ansible/hetzner.hcloud/_build?definitionId=35) [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/hetzner.hcloud)](https://codecov.io/gh/ansible-collections/hetzner.hcloud) -Ansible Collection: hetzner.hcloud -================================================= +# Ansible Collection: hetzner.hcloud Ansible Hetzner Cloud Collection for controlling your Hetzner Cloud Resources. +### Python version compatibility + +This collection depends on the [hcloud](https://github.com/hetznercloud/hcloud-python) library. Due to the [hcloud](https://github.com/hetznercloud/hcloud-python) Python Support Policy this collection requires Python 3.8 or greater. + ## Release notes See [here](https://github.com/ansible-collections/hetzner.hcloud/tree/master/CHANGELOG.rst). +### 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.hcloud_server` shows the documentation for the `hcloud_server` module. +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/ @@ -47,16 +56,9 @@ After this you should be able to use `ansible-test integration` to perform the i Sample: ``` -ansible-test integration --color --local -vvv hcloud_server // Executed all integration tests for hcloud_server module +ansible-test integration --color --local -vvv hetzner.hcloud.server // Executed all integration tests for server module ``` ## Releasing a new version -### Generating changelog from fragments - -1. Check if the changelog fragments are available (there should be files in `changelogs/fragments`) -2. Run `antsibull-changelog release --version `, it should remove all fragments and change - the `changelogs/changlog.yaml` and `CHANGELOG.rst` -3. Push the changes to the main branch -4. Tag the release through the Github UI, after this the Github Actions will run and publish the collection to Ansible - Galaxy +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. -- cgit v1.2.3