Update Terraform azurerm to v4 (#5)

### Added - Breaking Change * Update Terraform azurerm to v4 #### Migration Hints update your terraform azurerm to v4.0 or higher ### Changed * minor: update terraform documentation Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Andre Licht <[email protected]> Signed-off-by: Andre Licht <[email protected]>
cloudeteer · Aug 27, 2024 · 0e4ca71 · 0e4ca71
1 parent 1036cd6
commit 0e4ca71
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 19 deletions.
diff --git a/.terraform-docs.yaml b/.terraform-docs.yaml
@@ -1,7 +1,7 @@
-formatter: markdown
+formatter: markdown document
 
 settings:
-  anchor: false
+  hide-empty: true
   lockfile: false
 
 output:
@@ -14,8 +14,10 @@ sort:
 content: |-
   ## Usage
 
+  {{ include "examples/usage/main.md" }}
+
   ```hcl
-  {{ include "examples/main/usage.tf" }}
+  {{ include "examples/usage/main.tf" }}
   ```
 
   {{ .Providers }}

diff --git a/README.md b/README.md
@@ -1,10 +1,22 @@
+<!-- markdownlint-disable first-line-h1 no-inline-html -->
+
+> [!NOTE]
+> This repository is publicly accessible as part of our open-source initiative. We welcome contributions from the community alongside our organization's primary development efforts.
+
+---
+
 # terraform-azurerm-helloworld
 
+[![SemVer](https://img.shields.io/badge/SemVer-2.0.0-blue.svg)](CHANGELOG.md)
+[![Keep a Changelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.0.0-%23E05735)](CHANGELOG.md)
+
 Terraform "Hello World!" Module
 
 <!-- BEGIN_TF_DOCS -->
 ## Usage
 
+This example demonstrates the usage of this Terraform module with default settings.
+
 ```hcl
 module "helloworld" {
   source = "cloudeteer/helloworld/azurerm"
@@ -13,28 +25,43 @@ module "helloworld" {
 
 ## Providers
 
-| Name | Version |
-|------|---------|
-| azurerm | ~> 3.0 |
+The following providers are used by this module:
+
+- <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) (~> 4.0)
 
-## Modules
 
-No modules.
 
 ## Resources
 
-| Name | Type |
-|------|------|
-| [azurerm_client_config.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config) | data source |
+The following resources are used by this module:
+
+- [azurerm_client_config.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config) (data source)
 
-## Inputs
 
-No inputs.
 
 ## Outputs
 
-| Name | Description |
-|------|-------------|
-| client\_id | n/a |
-| hello\_world | n/a |
-<!-- END_TF_DOCS -->
+The following outputs are exported:
+
+### <a name="output_client_id"></a> [client\_id](#output\_client\_id)
+
+Description: n/a
+
+### <a name="output_hello_world"></a> [hello\_world](#output\_hello\_world)
+
+Description: n/a
+<!-- END_TF_DOCS -->
+
+## Contributions
+
+We welcome all kinds of contributions, whether it's reporting bugs, submitting feature requests, or directly contributing to the development. Please read our [Contributing Guidelines](CONTRIBUTING.md) to learn how you can best contribute.
+
+Thank you for your interest and support!
+
+## Copyright and license
+
+<img width=200 alt="Logo" src="https://raw.githubusercontent.com/cloudeteer/cdt-public/main/img/cdt_logo_orig_4c.svg">
+
+© 2024 CLOUDETEER GmbH
+
+This project is licensed under the [MIT License](LICENSE).
diff --git a/examples/usage/main.md b/examples/usage/main.md
@@ -0,0 +1 @@
+This example demonstrates the usage of this Terraform module with default settings.
diff --git a/examples/main/usage.tf → examples/usage/main.tf b/examples/main/usage.tf → examples/usage/main.tf
diff --git a/main.tf b/main.tf
@@ -4,7 +4,7 @@ terraform {
   required_providers {
     azurerm = {
       source  = "hashicorp/azurerm"
-      version = "~> 3.0"
+      version = "~> 4.0"
     }
   }
 }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		This example demonstrates the usage of this Terraform module with default settings.