Prepare relase 1.1.0 (#47) (#48)

* Prepare relase 1.1.0

* add documentation

Author: abikouo

CHANGELOG.rst

@@ -1,5 +1,56 @@
-Will be updated by antsibull-changelog. Do not edit this manually!
+============================================
+The cloud.terraform collection Release Notes
+============================================
 
-See https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelogs.rst for information on how to use antsibull-changelog.
+.. contents:: Topics
 
-Check out ``changelogs/config.yaml`` for its configuration. You need to change at least the ``title`` field in there.
+
+v1.1.0
+======
+
+Major Changes
+-------------
+
+- Added the git_plan role to apply a Terraform plan stored in a Git repository.
+- Added the inventory_from_outputs role to construct an in-memory inventory from Terraform outputs.
+- Added the terraform_output module which parses values from terraform outputs.
+- Check mode now works as intended and produces correct "changed" output and results.
+- Inventory plugin cloud.terraform.terraform_provider added. (https://github.com/ansible-collections/cloud.terraform/pull/22)
+- Support diff mode in cloud.terraform.terraform both in check mode and in non-check mode. (https://github.com/ansible-collections/cloud.terraform/pull/11)
+- Terraform output lookup module added (https://github.com/ansible-collections/cloud.terraform/pull/12).
+
+Minor Changes
+-------------
+
+- Removed "required_one_of" condition from terraform_output module. (https://github.com/ansible-collections/cloud.terraform/pull/31).
+- Slight code reorganization to always run terraform plan, and then optionally apply the generated plan.
+- Terraform output lookup module - documentation for state_file option updated. (https://github.com/ansible-collections/cloud.terraform/pull/29).
+- git_plan and inventory_from_outputs role's argument_spec.yml updated to be able to generate documentation (https://github.com/ansible-collections/cloud.terraform/pull/28)
+- meta/runtime.yml - Drop space in requires_ansible that was preventing the upload on Galaxy (https://github.com/ansible-collections/cloud.terraform/pull/8).
+
+Deprecated Features
+-------------------
+
+- state=planned is deprecated. Use check_mode=true at the module level instead.
+
+Bugfixes
+--------
+
+- Integration tests to test support of AWS, Azure and GCP.
+- Major refactoring of the cloud.terraform collection, restructuring and compartmentalizing code.
+- Removed "mutually exclusive" condition for state_file and project_path in inventory_from_outputs role, since terraform_output module doesn't require this. (https://github.com/ansible-collections/cloud.terraform/pull/39)
+- Several integration tests were added to test end-to-end behaviour.
+- Terraform module - fix now allows the possibility that the key "value" is not always present in the terraform plan thus avoiding KeyError. (https://github.com/ansible-collections/cloud.terraform/pull/45)
+- Terraform module - fix now expands the providers schema with block_types section so when checking if (block) attribute is sensitive in providers schema KeyError is now avoided. (https://github.com/ansible-collections/cloud.terraform/pull/46)
+- Terraform_output - fix now sets "outputs" variable to None in case of TerraformWarning to avoid undefined variable error. (https://github.com/ansible-collections/cloud.terraform/pull/31)
+- Type hints added to the cloud.terraform collection for easier future maintenance and reliability.
+- Updated host and group name in cloud.terraform.terraform_provider inventory plugin. (https://github.com/ansible-collections/cloud.terraform/pull/34)
+- terraform_output module - when providing name and state_file parameters, the value of the requested output wasn't returned. This issue was solved by changing the order of the name and state parameters in the invoked Terraform command (https://github.com/ansible-collections/cloud.terraform/pull/19).
+
+New Plugins
+-----------
+
+Inventory
+~~~~~~~~~
+
+- terraform_provider - Builds an inventory from Terraform state file.

README.md

@@ -26,27 +26,21 @@ This collection requires Ansible Core 2.13 or later and thus Python 3.8 or later
 
 ## Included content
 <!--start collection content-->
-### Modules
+### Inventory plugins
 Name | Description
 --- | ---
-[cloud.terraform.terraform](https://github.com/ansible-collections/cloud.terraform/blob/main/docs/cloud.terraform.terraform_module.rst)|Manages a Terraform deployment (and plans)
-[cloud.terraform.terraform_output](https://github.com/ansible-collections/cloud.terraform/blob/main/docs/cloud.terraform.terraform_output_module.rst)|Returns Terraform module outputs.
+[cloud.terraform.terraform_provider](https://github.com/ansible-collections/cloud.terraform/blob/main/docs/cloud.terraform.terraform_provider_inventory.rst)|Builds an inventory from Terraform state file.
 
-### Lookup
+### Lookup plugins
 Name | Description
 --- | ---
 [cloud.terraform.tf_output](https://github.com/ansible-collections/cloud.terraform/blob/main/docs/cloud.terraform.tf_output_lookup.rst)|Reads state file outputs.
 
-### Inventory
-Name | Description
---- | ---
-[cloud.terraform.terraform_provider](https://github.com/ansible-collections/cloud.terraform/blob/main/docs/cloud.terraform.terraform_provider_inventory.rst)|Builds an inventory from Terraform state file.
-
-### Roles
+### Modules
 Name | Description
 --- | ---
-[cloud.terraform.git_plan](https://github.com/ansible-collections/cloud.terraform/blob/main/docs/cloud.terraform.git_plan_role.rst)|Clones a Git repository and applys a plan from it.
-[cloud.terraform.inventory_from_outputs](https://github.com/ansible-collections/cloud.terraform/blob/main/docs/cloud.terraform.inventory_from_outputs_role.rst)|Creates an in-memory inventory from Terraform outputs.
+[cloud.terraform.terraform](https://github.com/ansible-collections/cloud.terraform/blob/main/docs/cloud.terraform.terraform_module.rst)|Manages a Terraform deployment (and plans)
+[cloud.terraform.terraform_output](https://github.com/ansible-collections/cloud.terraform/blob/main/docs/cloud.terraform.terraform_output_module.rst)|Returns Terraform module outputs.
 
 <!--end collection content-->
 
@@ -70,7 +64,7 @@ A specific version of the collection can be installed by using the `version` key
 ---
 collections:
   - name: cloud.terraform
-    version: 1.0.0
+    version: 1.1.0
 ```
 
 ## Using this collection
@@ -139,3 +133,4 @@ GNU General Public License v3.0 or later.
 
 See [LICENSE](https://github.com/ansible-collections/cloud.terraform/blob/main/LICENSE) to see the full text.
 
+

changelogs/changelog.yaml

@@ -1 +1,72 @@
-releases: {}
+ancestor: null
+releases:
+  1.1.0:
+    changes:
+      bugfixes:
+      - Integration tests to test support of AWS, Azure and GCP.
+      - Major refactoring of the cloud.terraform collection, restructuring and compartmentalizing
+        code.
+      - Removed "mutually exclusive" condition for state_file and project_path in
+        inventory_from_outputs role, since terraform_output module doesn't require
+        this. (https://github.com/ansible-collections/cloud.terraform/pull/39)
+      - Several integration tests were added to test end-to-end behaviour.
+      - Terraform module - fix now allows the possibility that the key "value" is
+        not always present in the terraform plan thus avoiding KeyError. (https://github.com/ansible-collections/cloud.terraform/pull/45)
+      - Terraform module - fix now expands the providers schema with block_types section
+        so when checking if (block) attribute is sensitive in providers schema KeyError
+        is now avoided. (https://github.com/ansible-collections/cloud.terraform/pull/46)
+      - Terraform_output - fix now sets "outputs" variable to None in case of TerraformWarning
+        to avoid undefined variable error. (https://github.com/ansible-collections/cloud.terraform/pull/31)
+      - Type hints added to the cloud.terraform collection for easier future maintenance
+        and reliability.
+      - Updated host and group name in cloud.terraform.terraform_provider inventory
+        plugin. (https://github.com/ansible-collections/cloud.terraform/pull/34)
+      - terraform_output module - when providing name and state_file parameters, the
+        value of the requested output wasn't returned. This issue was solved by changing
+        the order of the name and state parameters in the invoked Terraform command
+        (https://github.com/ansible-collections/cloud.terraform/pull/19).
+      deprecated_features:
+      - state=planned is deprecated. Use check_mode=true at the module level instead.
+      major_changes:
+      - Added the git_plan role to apply a Terraform plan stored in a Git repository.
+      - Added the inventory_from_outputs role to construct an in-memory inventory
+        from Terraform outputs.
+      - Added the terraform_output module which parses values from terraform outputs.
+      - Check mode now works as intended and produces correct "changed" output and
+        results.
+      - Inventory plugin cloud.terraform.terraform_provider added. (https://github.com/ansible-collections/cloud.terraform/pull/22)
+      - Support diff mode in cloud.terraform.terraform both in check mode and in non-check
+        mode. (https://github.com/ansible-collections/cloud.terraform/pull/11)
+      - Terraform output lookup module added (https://github.com/ansible-collections/cloud.terraform/pull/12).
+      minor_changes:
+      - Removed "required_one_of" condition from terraform_output module. (https://github.com/ansible-collections/cloud.terraform/pull/31).
+      - Slight code reorganization to always run terraform plan, and then optionally
+        apply the generated plan.
+      - Terraform output lookup module - documentation for state_file option updated.
+        (https://github.com/ansible-collections/cloud.terraform/pull/29).
+      - git_plan and inventory_from_outputs role's argument_spec.yml updated to be
+        able to generate documentation (https://github.com/ansible-collections/cloud.terraform/pull/28)
+      - meta/runtime.yml - Drop space in requires_ansible that was preventing the
+        upload on Galaxy (https://github.com/ansible-collections/cloud.terraform/pull/8).
+    fragments:
+    - 0001-initial.yml
+    - 10-zuul-integration-tests.yml
+    - add_diff_mode_for_state_file.yaml
+    - change_name_and_state_order_in_terraform_command.yaml
+    - drop_sapce_in_requires_ansible.yaml
+    - inventory_from_outputs_bugfix.yaml
+    - refactoring.yaml
+    - terraform_module_sensitive_values_bugfix.yaml
+    - terraform_module_show_values_bugfix.yaml
+    - terraform_output_module.yaml
+    - terraform_provider_inventory_plugin.yaml
+    - terraform_provider_update_host_and_group_name.yaml
+    - tf_output_lookup_module.yaml
+    - tf_output_lookup_module_documentation_update.yaml
+    - update_documentation.yaml
+    plugins:
+      inventory:
+      - description: Builds an inventory from Terraform state file.
+        name: terraform_provider
+        namespace: null
+    release_date: '2023-03-23'