Update tf-docs and release drafter (#3)

Flaconi · Oct 12, 2021 · 3b1a52b · 3b1a52b
1 parent db59b17
commit 3b1a52b
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 20 deletions.
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -1,6 +1,6 @@
 # Configuration for Release Drafter: https://github.com/toolmantim/release-drafter
-name-template: '$NEXT_MINOR_VERSION 🌈'
-tag-template: '$NEXT_MINOR_VERSION'
+name-template: 'v$NEXT_MINOR_VERSION 🌈'
+tag-template: 'v$NEXT_MINOR_VERSION'
 categories:
   - title: '🚀 Features'
     labels:

diff --git a/Makefile b/Makefile
@@ -20,7 +20,7 @@ FL_IGNORE_PATHS = .git/,.github/,.idea/
 # -------------------------------------------------------------------------------------------------
 # Terraform-docs configuration
 # -------------------------------------------------------------------------------------------------
-TFDOCS_VERSION = 0.9.1-0.28
+TFDOCS_VERSION = 0.15.0-0.29
 
 # Adjust your delimiter here or overwrite via make arguments
 TFDOCS_DELIM_START = <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
@@ -81,7 +81,7 @@ terraform-docs: _pull-tfdocs
     -e TFDOCS_DELIM_START='$(TFDOCS_DELIM_START)' \
     -e TFDOCS_DELIM_CLOSE='$(TFDOCS_DELIM_CLOSE)' \
     cytopia/terraform-docs:$(TFDOCS_VERSION) \
-    terraform-docs-replace --sort-inputs-by-required --with-aggregate-type-defaults md README.md; then \
+    terraform-docs-replace --sort-by required markdown README.md; then \
     echo "OK"; \
   else \
     echo "Failed"; \

diff --git a/README.md b/README.md
@@ -44,37 +44,64 @@ Example:
 
 | Name | Version |
 |------|---------|
-| terraform | >= 0.12.26 |
-| aws | >= 3 |
-| random | >= 3.1 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.26 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3 |
+| <a name="requirement_random"></a> [random](#requirement\_random) | >= 3.1 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| aws | >= 3 |
-| random | >= 3.1 |
-| template | n/a |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3 |
+| <a name="provider_random"></a> [random](#provider\_random) | >= 3.1 |
+| <a name="provider_template"></a> [template](#provider\_template) | n/a |
+
+## Modules
+
+No modules.
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [aws_autoscaling_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/autoscaling_group) | resource |
+| [aws_cloudwatch_log_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
+| [aws_iam_instance_profile.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) | resource |
+| [aws_iam_role.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
+| [aws_iam_role_policy.kms](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource |
+| [aws_iam_role_policy_attachment.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
+| [aws_kms_key.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_key) | resource |
+| [aws_launch_configuration.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_configuration) | resource |
+| [aws_security_group.allow_egress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
+| [aws_ssm_document.session_manager_prefs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_document) | resource |
+| [random_string.this](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string) | resource |
+| [aws_ami.amazon_linux_2](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | data source |
+| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
+| [aws_iam_policy_document.kms_key_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+| [aws_iam_policy_document.kms_key_policy_iam_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+| [aws_iam_policy_document.trust_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
+| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |
+| [template_file.init](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/file) | data source |
 
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| subnet\_ids | The subnets where the Bastion can reside in, they can be private | `list(string)` | n/a | yes |
-| vpc\_id | The VPC-ID | `string` | n/a | yes |
-| create\_new\_ssm\_document | This module can create a new SSM document for the SSH Terminal | `bool` | `false` | no |
-| create\_security\_group | This module can create a security group for the bastion instance by default | `bool` | `true` | no |
-| instance\_type | The instance type of the bastion | `string` | `"t3.nano"` | no |
-| log\_retention | The amount of days the logs need to be kept | `number` | `30` | no |
-| name | The name to be interpolated, defaults to bastion-ssm-iam | `string` | `"bastion-ssm-iam"` | no |
-| security\_group\_ids | The security group ids which can be given to the bastion instance, defaults to empty | `list(string)` | `[]` | no |
+| <a name="input_subnet_ids"></a> [subnet\_ids](#input\_subnet\_ids) | The subnets where the Bastion can reside in, they can be private | `list(string)` | n/a | yes |
+| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The VPC-ID | `string` | n/a | yes |
+| <a name="input_create_new_ssm_document"></a> [create\_new\_ssm\_document](#input\_create\_new\_ssm\_document) | This module can create a new SSM document for the SSH Terminal | `bool` | `false` | no |
+| <a name="input_create_security_group"></a> [create\_security\_group](#input\_create\_security\_group) | This module can create a security group for the bastion instance by default | `bool` | `true` | no |
+| <a name="input_instance_type"></a> [instance\_type](#input\_instance\_type) | The instance type of the bastion | `string` | `"t3.nano"` | no |
+| <a name="input_log_retention"></a> [log\_retention](#input\_log\_retention) | The amount of days the logs need to be kept | `number` | `30` | no |
+| <a name="input_name"></a> [name](#input\_name) | The name to be interpolated, defaults to bastion-ssm-iam | `string` | `"bastion-ssm-iam"` | no |
+| <a name="input_security_group_ids"></a> [security\_group\_ids](#input\_security\_group\_ids) | The security group ids which can be given to the bastion instance, defaults to empty | `list(string)` | `[]` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| ssm\_document\_name | The document name of SSM |
-| this\_security\_group\_id | The security group id of the bastion server |
+| <a name="output_ssm_document_name"></a> [ssm\_document\_name](#output\_ssm\_document\_name) | The document name of SSM |
+| <a name="output_this_security_group_id"></a> [this\_security\_group\_id](#output\_this\_security\_group\_id) | The security group id of the bastion server |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->