update readme, prepare for 5.0.0

Author: lonegunmanb

CHANGELOG-v4.md

@@ -0,0 +1,41 @@
+# Changelog
+
+## [4.2.0](https://github.com/Azure/terraform-azurerm-compute/tree/4.2.0) (2022-12-22)
+
+**Merged pull requests:**
+
+- Changed var.location default value from "" to null [\#214](https://github.com/Azure/terraform-azurerm-compute/pull/214) ([juanjojulian](https://github.com/juanjojulian))
+- Bump tflint plugin version, add new checking rule [\#213](https://github.com/Azure/terraform-azurerm-compute/pull/213) ([lonegunmanb](https://github.com/lonegunmanb))
+- Upgrade `terraform-module-test-helper` lib so we can get rid of override file to execute version upgrade test [\#212](https://github.com/Azure/terraform-azurerm-compute/pull/212) ([lonegunmanb](https://github.com/lonegunmanb))
+
+## [4.1.0](https://github.com/Azure/terraform-azurerm-compute/tree/4.1.0) (2022-11-29)
+
+**Merged pull requests:**
+
+- Add support for `azurerm_virtual_machine_extension` resource. [\#210](https://github.com/Azure/terraform-azurerm-compute/pull/210) ([lonegunmanb](https://github.com/lonegunmanb))
+- Add support for `plan` block [\#209](https://github.com/Azure/terraform-azurerm-compute/pull/209) ([lonegunmanb](https://github.com/lonegunmanb))
+- Support boot diagnostics storage injection [\#208](https://github.com/Azure/terraform-azurerm-compute/pull/208) ([lonegunmanb](https://github.com/lonegunmanb))
+- Add support for network security group injection [\#205](https://github.com/Azure/terraform-azurerm-compute/pull/205) ([lonegunmanb](https://github.com/lonegunmanb))
+- Solve \#107 by adding `create_before_destroy = true` to defer public ip's deletion. [\#203](https://github.com/Azure/terraform-azurerm-compute/pull/203) ([lonegunmanb](https://github.com/lonegunmanb))
+- Output vm names [\#202](https://github.com/Azure/terraform-azurerm-compute/pull/202) ([lonegunmanb](https://github.com/lonegunmanb))
+- Make `azurerm_availability_set`'s `platform_fault_domain_count` and `platform_update_domain_count` configurable [\#201](https://github.com/Azure/terraform-azurerm-compute/pull/201) ([lonegunmanb](https://github.com/lonegunmanb))
+- Fix the bug introduced by \#189 by adding `var.storage_os_disk_size_gb` back. [\#200](https://github.com/Azure/terraform-azurerm-compute/pull/200) ([lonegunmanb](https://github.com/lonegunmanb))
+- Add support for `azurerm_virtual_machine.zones` [\#199](https://github.com/Azure/terraform-azurerm-compute/pull/199) ([lonegunmanb](https://github.com/lonegunmanb))
+- Convert legacy splat syntax into bracket syntax [\#198](https://github.com/Azure/terraform-azurerm-compute/pull/198) ([lonegunmanb](https://github.com/lonegunmanb))
+- Replacing location and resource\_group\_name with local variables [\#196](https://github.com/Azure/terraform-azurerm-compute/pull/196) ([jiaweitao001](https://github.com/jiaweitao001))
+- Removing depends\_on in examples code [\#195](https://github.com/Azure/terraform-azurerm-compute/pull/195) ([jiaweitao001](https://github.com/jiaweitao001))
+- Add override template file so we can run version upgrade test [\#194](https://github.com/Azure/terraform-azurerm-compute/pull/194) ([lonegunmanb](https://github.com/lonegunmanb))
+- Rename some resources to snake case. [\#193](https://github.com/Azure/terraform-azurerm-compute/pull/193) ([lonegunmanb](https://github.com/lonegunmanb))
+- Refactor code to meet tflint's requirements [\#189](https://github.com/Azure/terraform-azurerm-compute/pull/189) ([lonegunmanb](https://github.com/lonegunmanb))
+- Allow custom OS disk size [\#183](https://github.com/Azure/terraform-azurerm-compute/pull/183) ([yatzek](https://github.com/yatzek))
+
+## [4.0.0](https://github.com/Azure/terraform-azurerm-compute/tree/4.0.0) (2022-11-15)
+
+**Merged pull requests:**
+
+- Add CI pipeline [\#185](https://github.com/Azure/terraform-azurerm-compute/pull/185) ([jiaweitao001](https://github.com/jiaweitao001))
+- Adding Microsoft SECURITY.MD [\#181](https://github.com/Azure/terraform-azurerm-compute/pull/181) ([microsoft-github-policy-service[bot]](https://github.com/apps/microsoft-github-policy-service))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

CHANGELOG.md

@@ -1,5 +0,0 @@
-# Changelog
-
-
-
-\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

README.md

@@ -1,12 +1,34 @@
 # terraform-azurerm-compute
 
-## Notice on Upgrade to V4.x
+## Notice on Upgrade to v5.x
+
+As [#218](https://github.com/Azure/terraform-azurerm-compute/pull/218) described, the `plan` block introduced by [#209](https://github.com/Azure/terraform-azurerm-compute/pull/209) was incorrect so we must adjust the assignments' order, which is a breaking change. The change we've made to vm's `plan` block is:
+
+```hcl
+dynamic "plan" {
+  for_each = var.is_marketplace_image ? ["plan"] : []
+
+  content {
+  -      name      = var.vm_os_offer
+  -      product   = var.vm_os_sku
+  +      name      = var.vm_os_sku
+  +      product   = var.vm_os_offer
+    publisher = var.vm_os_publisher
+  }
+}
+```
+
+Now `vm_os_sku` would be used as `plan.name` and `vm_os_offer` would be used as `plan.product`.
+
+v5.0.0 is a major version upgrade. Extreme caution must be taken during the upgrade to avoid resource replacement and downtime by accident.
+
+## Notice on Upgrade to v4.x
 
 We've added a CI pipeline for this module to speed up our code review and to enforce a high code quality standard, if you want to contribute by submitting a pull request, please read [Pre-Commit & Pr-Check & Test](#Pre-Commit--Pr-Check--Test) section, or your pull request might be rejected by CI pipeline.
 
 A pull request will be reviewed when it has passed Pre Pull Request Check in the pipeline, and will be merged when it has passed the acceptance tests. Once the ci Pipeline failed, please read the pipeline's output, thanks for your cooperation.
 
-V4.0.0 is a major version upgrade. Extreme caution must be taken during the upgrade to avoid resource replacement and downtime by accident.
+v4.0.0 is a major version upgrade. Extreme caution must be taken during the upgrade to avoid resource replacement and downtime by accident.
 
 Running the `terraform plan` first to inspect the plan is strongly advised.