fix: Update upgrade template; only deploy when not an HTTP API

Author: bryantbiggs

README.md

@@ -153,7 +153,7 @@ module "api_gateway" {
 | <a name="input_create_routes_and_integrations"></a> [create\_routes\_and\_integrations](#input\_create\_routes\_and\_integrations) | Whether to create routes and integrations resources | `bool` | `true` | no |
 | <a name="input_create_stage"></a> [create\_stage](#input\_create\_stage) | Whether to create default stage | `bool` | `true` | no |
 | <a name="input_credentials_arn"></a> [credentials\_arn](#input\_credentials\_arn) | Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs | `string` | `null` | no |
-| <a name="input_deploy_stage"></a> [deploy\_stage](#input\_deploy\_stage) | Whether to deploy the stage | `bool` | `true` | no |
+| <a name="input_deploy_stage"></a> [deploy\_stage](#input\_deploy\_stage) | Whether to deploy the stage. `HTTP` APIs are auto-deployed by default | `bool` | `true` | no |
 | <a name="input_description"></a> [description](#input\_description) | The description of the API. Must be less than or equal to 1024 characters in length | `string` | `null` | no |
 | <a name="input_disable_execute_api_endpoint"></a> [disable\_execute\_api\_endpoint](#input\_disable\_execute\_api\_endpoint) | Whether clients can invoke the API by using the default execute-api endpoint. By default, clients can invoke the API with the default `{api_id}.execute-api.{region}.amazonaws.com endpoint`. To require that clients use a custom domain name to invoke the API, disable the default endpoint | `bool` | `null` | no |
 | <a name="input_domain_name"></a> [domain\_name](#input\_domain\_name) | The domain name to use for API gateway | `string` | `""` | no |

UPGRADE-3.0.md

@@ -0,0 +1,62 @@
+# Upgrade from v4.x to v5.x
+
+Please consult the `examples` directory for reference example configurations. If you find a bug, please open an issue with supporting configuration to reproduce.
+
+## List of backwards incompatible changes
+
+- Minimum supported Terraform version increased to `v1.3` to support Terraform state `moved` blocks as well as other advanced features
+
+## Additional changes
+
+### Added
+
+   -
+
+### Modified
+
+   -
+
+### Removed
+
+   -
+
+### Variable and output changes
+
+1. Removed variables:
+
+   -
+
+2. Renamed variables:
+
+   -
+
+3. Added variables:
+
+   -
+
+4. Removed outputs:
+
+   -
+
+5. Renamed outputs:
+
+   -
+
+6. Added outputs:
+
+   -
+
+## Upgrade Migrations
+
+### Diff of Before (v4.0) vs After (v5.0)
+
+```diff
+ module "apigateway_v2" {
+   source  = "terraform-aws-modules/apigateway-v2/aws"
+-  version = "~> 4.0"
++  version = "~> 5.0"
+
+}
+```
+
+## Terraform State Moves

UPGRADE-5.0.md

@@ -329,7 +329,7 @@ resource "aws_apigatewayv2_stage" "this" {
 ################################################################################
 
 resource "aws_apigatewayv2_deployment" "this" {
-  count = local.create_stage && var.deploy_stage && var.stage_name != "$default" ? 1 : 0
+  count = local.create_stage && var.deploy_stage && !local.is_http ? 1 : 0
 
   api_id      = aws_apigatewayv2_api.this[0].id
   description = var.description

main.tf

@@ -241,7 +241,7 @@ variable "stage_tags" {
 ################################################################################
 
 variable "deploy_stage" {
-  description = "Whether to deploy the stage"
+  description = "Whether to deploy the stage. `HTTP` APIs are auto-deployed by default"
   type        = bool
   default     = true
 }