chore: basic documentation & add release github action

Author: kewalaka

.github/dependabot.yml

@@ -9,4 +9,14 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/.github/workflows"
     schedule:
-      interval: daily
+      interval: 'weekly'
+      day: 'saturday'
+      time: '07:00'
+      timezone: 'Pacific/Auckland'
+  - package-ecosystem: 'terraform'
+    directory: '/' # Location of package manifests
+    schedule:
+      interval: 'weekly'
+      day: 'saturday'
+      time: '07:00'
+      timezone: 'Pacific/Auckland'

.github/workflows/create-release.yml

@@ -0,0 +1,22 @@
+---
+name: create-release
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  Release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ncipollo/release-action@v1
+        with:
+          generateReleaseNotes: true
+          name: '${{ github.ref_name }}'
+          token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -26,12 +26,17 @@ override.tf.json
 # Include override files you do wish to add to version control using negated pattern
 # !example_override.tf
 
+# Ignore Terraform lock file
+.terraform.lock.hcl
+
 # Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
 # example: *tfplan*
 
 # Ignore CLI configuration files
 .terraformrc
 terraform.rc
-
-# lock files
-**/.terraform.lock.hcl
+*tfplan*
+README-generated.md
+avm.tflint.hcl
+avm.tflint_example.hcl
+avmmakefile

.terraform-docs.yml

@@ -4,7 +4,7 @@
 
 formatter: "markdown document" # this is required
 
-version: "0.16.0"
+version: "0.17.0"
 
 header-from: "_header.md"
 footer-from: "_footer.md"

.vscode/extensions.json

@@ -4,6 +4,7 @@
     "editorconfig.editorconfig",
     "azapi-vscode.azapi",
     "ms-vscode-remote.remote-wsl",
-    "ms-vscode-remote.remote-containers"
+    "ms-vscode-remote.remote-containers",
+    "davidanson.vscode-markdownlint"
   ]
 }

README.md

@@ -1,11 +1,26 @@
 <!-- BEGIN_TF_DOCS -->
-# terraform-azurerm-avm-res-container-apps
+# terraform-azapi-res-container-apps
 
-This is a repo for Container Apps in the style of Azure Verified Modules (AVM), it is an 'unofficial' example that has been used for learning AVM.
+This is a repo for Container Apps ***in the style of*** Azure Verified Modules (AVM), for official AVM modules, please see <https://aka.ms/AVM>.
+
+Whilst this uses the AzApi provider, a key design pattern is to standardarise the variable definition so it is as close to the existing AzureRM resource as possible (augmenting as needed to support parameters that are currently not supported by the AzureRM provider).
+
+Currently implemented parameters cover;
+
+- dapr
+- container
+- ingress
+- probes (liveness, readiness & startup)
+- secrets
+- registries
 
 Note this uses the AZAPI provider because of support missing within the AzureRM provider for [workload profiles](https://github.com/hashicorp/terraform-provider-azurerm/issues/21747).
 
-Once required functionality is available within AzureRM, [azapi2azurerm](https://github.com/Azure/azapi2azurerm) can be used to convert this code.
+## Background
+
+This project was originally written because the AzAPI provider was missing within the AzureRM provider for [workload profiles](https://github.com/hashicorp/terraform-provider-azurerm/issues/21747).
+
+This can be converted using [azapi2azurerm](https://github.com/Azure/azapi2azurerm) once Container Apps support stablises in the Azure RM provider.
 
 This project includes [examples](./examples/) showing default settings and an example from Microsoft Learn illustrating Dapr.
 

_header.md

@@ -1,10 +1,25 @@
-# terraform-azurerm-avm-res-container-apps
+# terraform-azapi-res-container-apps
 
-This is a repo for Container Apps in the style of Azure Verified Modules (AVM), it is an 'unofficial' example that has been used for learning AVM.
+This is a repo for Container Apps ***in the style of*** Azure Verified Modules (AVM), for official AVM modules, please see <https://aka.ms/AVM>.
+
+Whilst this uses the AzApi provider, a key design pattern is to standardarise the variable definition so it is as close to the existing AzureRM resource as possible (augmenting as needed to support parameters that are currently not supported by the AzureRM provider).
+
+Currently implemented parameters cover;
+
+- dapr
+- container
+- ingress
+- probes (liveness, readiness & startup)
+- secrets
+- registries
 
 Note this uses the AZAPI provider because of support missing within the AzureRM provider for [workload profiles](https://github.com/hashicorp/terraform-provider-azurerm/issues/21747).
 
-Once required functionality is available within AzureRM, [azapi2azurerm](https://github.com/Azure/azapi2azurerm) can be used to convert this code.
+## Background
+
+This project was originally written because the AzAPI provider was missing within the AzureRM provider for [workload profiles](https://github.com/hashicorp/terraform-provider-azurerm/issues/21747).
+
+This can be converted using [azapi2azurerm](https://github.com/Azure/azapi2azurerm) once Container Apps support stablises in the Azure RM provider.
 
 This project includes [examples](./examples/) showing default settings and an example from Microsoft Learn illustrating Dapr.
 

examples/.terraform-docs.yml

@@ -4,7 +4,7 @@
 
 formatter: "markdown document" # this is required
 
-version: "0.16.0"
+version: "0.17.0"
 
 header-from: "_header.md"
 footer-from: "_footer.md"