diff --git a/CHANGELOG.rst b/CHANGELOG.rst index bc0f576..a3d9532 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,11 +4,21 @@ Hetzner Cloud Ansible Collection Release Notes .. contents:: Topics + +v1.3.1 +====== + +Bugfixes +-------- + +- hcloud_server - fix a crash related to check mode if ``state=started`` or ``state=stopped`` (https://github.com/ansible-collections/hetzner.hcloud/issues/54). + v1.3.0 ====== Minor Changes --------- +------------- + - Add firewalls to hcloud_server module New Modules @@ -16,14 +26,13 @@ New Modules - hcloud_firewall - Manage Hetzner Cloud Firewalls - v1.2.1 ====== Bugfixes -------- -- Inventory Restore Python 2.7 compatibility +- Inventory Restore Python 2.7 compatibility v1.2.0 ====== diff --git a/README.md b/README.md index 6d88966..24b31e7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - [![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) [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/hetzner.hcloud)](https://codecov.io/gh/ansible-collections/hetzner.hcloud) @@ -11,13 +10,53 @@ Ansible Hetzner Cloud Collection for controlling your Hetzner Cloud Resources. See [here](https://github.com/ansible-collections/hetzner.hcloud/tree/master/CHANGELOG.rst). +## Documentation -## Publishing New Version +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. -TBD Basic instructions without release branches: +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/ -1. Create `changelogs/fragments/.yml` with `release_summary:` section (which must be a string, not a list). -2. Run `antsibull-changelog release --collection-flatmap yes` -3. Make sure `CHANGELOG.rst` and `changelogs/changelog.yaml` are added to git, and the deleted fragments have been removed. -4. Tag the commit with ``. Push changes and tag to the main repository. +# Development + +## Requirements + +You should place the collection (clone the repository) into the Ansible collection path. Normally this +is `~/.ansible/collections/ansible_collections// +``` + +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 hcloud_server // Executed all integration tests for hcloud_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 master branch +4. Tag the release through the Github UI, after this the Github Actions will run and publish the collection to Ansible + Galaxy diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 6e7e796..41edf3c 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -75,10 +75,17 @@ releases: 1.3.0: changes: minor_changes: - - Add firewalls to hcloud_server module + - Add firewalls to hcloud_server module modules: - description: Manage Hetzner Cloud Firewalls name: hcloud_firewall namespace: '' release_date: '2021-03-11' - + 1.3.1: + changes: + bugfixes: + - hcloud_server - fix a crash related to check mode if ``state=started`` or + ``state=stopped`` (https://github.com/ansible-collections/hetzner.hcloud/issues/54). + fragments: + - 64-hcloud_server_fix_checkmode_state_started.yml + release_date: '2021-03-18' diff --git a/changelogs/fragments/64-hcloud_server_fix_checkmode_state_started.yml b/changelogs/fragments/64-hcloud_server_fix_checkmode_state_started.yml deleted file mode 100644 index 53ada8b..0000000 --- a/changelogs/fragments/64-hcloud_server_fix_checkmode_state_started.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - hcloud_server - fix a crash related to check mode if ``state=started`` or ``state=stopped`` (https://github.com/ansible-collections/hetzner.hcloud/issues/54).