Merge pull request #48 from clouddrove/fix/comments

fix: Standardize Comments
clouddrove · Oct 2, 2023 · f87bd40 · f87bd40
2 parents d6406d7 + 7fd25eb
commit f87bd40
Show file tree

Hide file tree

Showing 14 changed files with 110 additions and 110 deletions.
diff --git a/.github/workflows/auto_assignee.yml b/.github/workflows/auto_assignee.yml
@@ -5,7 +5,7 @@ on:
   workflow_dispatch:
 jobs:
   assignee:
-    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].5
+    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].6
     secrets:
       GITHUB: ${{ secrets.GITHUB }}
     with:

diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 jobs:
   changelog:
-    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].5
+    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].6
     secrets: inherit
     with:
       branch: 'master'
diff --git a/.github/workflows/tf-checks.yml b/.github/workflows/tf-checks.yml
@@ -6,34 +6,34 @@ on:
   workflow_dispatch:
 jobs:
   tf-checks-complete-example:
-    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].5
+    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].6
     with:
       working_directory: './_example/complete/'
   tf-checks-cors_s3-example:
-    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].5
+    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].6
     with:
       working_directory: './_example/cors_s3/'
   tf-checks-default-s3-example:
-    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].5
+    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].6
     with:
       working_directory: './_example/default-s3/'
   tf-checks-encryption-s3-example:
-    uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@master
+    uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.0.6
     with:
       working_directory: './_example/encryption-s3/'
   tf-checks-logging-encryption-s3-example:
-    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].5
+    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].6
     with:
       working_directory: './_example/logging-encryption-s3/'
   tf-checks-logging-s3-example:
-    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].5
+    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].6
     with:
       working_directory: './_example/logging-s3/'
   tf-checks-s3-replication-example:
-    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].5
+    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].6
     with:
       working_directory: './_example/s3-replication/'
   tf-checks-website-s3-example:
-    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].5
+    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].6
     with:
       working_directory: './_example/website-s3/'
diff --git a/.github/workflows/tflint.yml b/.github/workflows/tflint.yml
@@ -6,6 +6,6 @@ on:
   workflow_dispatch:
 jobs:
   tf-lint:
-    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].5
+    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].6
     secrets:
       GITHUB: ${{ secrets.GITHUB }}
diff --git a/.github/workflows/tfsec.yml b/.github/workflows/tfsec.yml
@@ -5,7 +5,7 @@ on:
   workflow_dispatch:
 jobs:
   tfsec:
-    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].5
+    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].6
     secrets: inherit
     with:
       working_directory: '.'
diff --git a/_example/complete/example.tf b/_example/complete/example.tf
@@ -1,6 +1,6 @@
-####----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Provider block added, Use the Amazon Web Services (AWS) provider to interact with the many resources supported by AWS.
-####----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 provider "aws" {
   region = "eu-west-1"
 }
@@ -12,9 +12,9 @@ locals {
 }
 
 data "aws_canonical_user_id" "current" {}
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Provides details about a specific S3 bucket.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 module "logging_bucket" {
   source = "./../../"
 
@@ -49,9 +49,9 @@ module "subnets" {
   ipv6_cidr_block    = module.vpc.ipv6_cidr_block
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Below resources will create KMS-KEY and its components.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 module "kms_key" {
   source      = "clouddrove/kms/aws"
   version     = "1.3.1"
@@ -67,9 +67,9 @@ module "kms_key" {
   policy                  = data.aws_iam_policy_document.default.json
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Generates an IAM policy document in JSON format for use with resources that expect policy documents such as aws_iam_policy.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 data "aws_iam_policy_document" "default" {
   version = "2012-10-17"
   statement {
@@ -84,9 +84,9 @@ data "aws_iam_policy_document" "default" {
   }
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Provides details about a specific S3 bucket.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 module "s3_bucket" {
   source = "./../../"
 

diff --git a/_example/cors_s3/example.tf b/_example/cors_s3/example.tf
@@ -1,6 +1,6 @@
-####----------------------------------------------------------------------------------
+####-----------------------------------------------------------------------------
 ## Provider block added, Use the Amazon Web Services (AWS) provider to interact with the many resources supported by AWS.
-####----------------------------------------------------------------------------------
+####-----------------------------------------------------------------------------
 provider "aws" {
   region = "eu-west-1"
 }
@@ -10,9 +10,9 @@ locals {
   label_order = ["name", "environment"]
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Provides details about a specific S3 bucket.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 module "s3_bucket" {
   source = "./../../"
 

diff --git a/_example/default-s3/example.tf b/_example/default-s3/example.tf
@@ -1,6 +1,6 @@
-####----------------------------------------------------------------------------------
+####-----------------------------------------------------------------------------
 ## Provider block added, Use the Amazon Web Services (AWS) provider to interact with the many resources supported by AWS.
-####----------------------------------------------------------------------------------
+####-----------------------------------------------------------------------------
 provider "aws" {
   region = "eu-west-1"
 }
@@ -10,9 +10,9 @@ locals {
   label_order = ["name", "environment"]
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Provides details about a default S3 bucket.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 module "s3_bucket" {
   source = "./../../"
 

diff --git a/_example/encryption-s3/example.tf b/_example/encryption-s3/example.tf
@@ -1,6 +1,6 @@
-####----------------------------------------------------------------------------------
+####-----------------------------------------------------------------------------
 ## Provider block added, Use the Amazon Web Services (AWS) provider to interact with the many resources supported by AWS.
-####----------------------------------------------------------------------------------
+####-----------------------------------------------------------------------------
 provider "aws" {
   region = "eu-west-1"
 }
@@ -10,9 +10,9 @@ locals {
   label_order = ["name", "environment"]
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Below resources will create KMS-KEY and its components.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 module "kms_key" {
   source      = "clouddrove/kms/aws"
   version     = "1.3.1"
@@ -28,9 +28,9 @@ module "kms_key" {
   policy                  = data.aws_iam_policy_document.default.json
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Generates an IAM policy document in JSON format for use with resources that expect policy documents such as aws_iam_policy.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 data "aws_iam_policy_document" "default" {
   version = "2012-10-17"
   statement {
@@ -45,9 +45,9 @@ data "aws_iam_policy_document" "default" {
   }
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Provides details about a specific S3 bucket.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 module "s3_bucket" {
   source = "./../../"
 

diff --git a/_example/logging-encryption-s3/example.tf b/_example/logging-encryption-s3/example.tf
@@ -1,6 +1,6 @@
-####----------------------------------------------------------------------------------
+####-----------------------------------------------------------------------------
 ## Provider block added, Use the Amazon Web Services (AWS) provider to interact with the many resources supported by AWS.
-####----------------------------------------------------------------------------------
+####-----------------------------------------------------------------------------
 provider "aws" {
   region = "eu-west-1"
 }
@@ -10,9 +10,9 @@ locals {
   label_order = ["name", "environment"]
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Provides details about a logging S3 bucket.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 module "logging_bucket" {
   source = "./../../"
 
@@ -23,9 +23,9 @@ module "logging_bucket" {
   acl         = "log-delivery-write"
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Below resources will create KMS-KEY and its components.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 module "kms_key" {
   source      = "clouddrove/kms/aws"
   version     = "1.3.1"
@@ -41,9 +41,9 @@ module "kms_key" {
   policy                  = data.aws_iam_policy_document.default.json
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Generates an IAM policy document in JSON format for use with resources that expect policy documents such as aws_iam_policy.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 data "aws_iam_policy_document" "default" {
   version = "2012-10-17"
   statement {
@@ -58,9 +58,9 @@ data "aws_iam_policy_document" "default" {
   }
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Provides details about a specific S3 bucket.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 module "s3_bucket" {
   source = "./../../"
 

diff --git a/_example/logging-s3/example.tf b/_example/logging-s3/example.tf
@@ -1,6 +1,6 @@
-####----------------------------------------------------------------------------------
+####-----------------------------------------------------------------------------
 ## Provider block added, Use the Amazon Web Services (AWS) provider to interact with the many resources supported by AWS.
-####----------------------------------------------------------------------------------
+####-----------------------------------------------------------------------------
 provider "aws" {
   region = "eu-west-1"
 }
@@ -10,9 +10,9 @@ locals {
   label_order = ["name", "environment"]
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Provides details about a logging S3 bucket.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 module "logging_bucket" {
   source = "./../../"
 
@@ -23,9 +23,9 @@ module "logging_bucket" {
   acl         = "log-delivery-write"
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Provides details about a specific S3 bucket.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 module "s3_bucket" {
   source = "./../../"
 

diff --git a/_example/s3-replication/example.tf b/_example/s3-replication/example.tf
@@ -1,6 +1,6 @@
-####----------------------------------------------------------------------------------
+####-----------------------------------------------------------------------------
 ## Provider block added, Use the Amazon Web Services (AWS) provider to interact with the many resources supported by AWS.
-####----------------------------------------------------------------------------------
+####-----------------------------------------------------------------------------
 provider "aws" {
   region = "eu-west-1"
 }
@@ -17,18 +17,18 @@ locals {
   label_order = ["name", "environment"]
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Below resources will create KMS-KEY and its components.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 resource "aws_kms_key" "replica" {
   provider                = aws.replica
   description             = "S3 bucket replication KMS key"
   deletion_window_in_days = 7
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Provides details about a replica S3 bucket.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 module "replica_bucket" {
   source = "../../"
 
@@ -42,9 +42,9 @@ module "replica_bucket" {
   acl         = "private"
   versioning  = true
 }
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Provides details about a specific S3 bucket.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 module "s3_bucket" {
   source = "../../"
 
@@ -137,9 +137,9 @@ module "s3_bucket" {
   }
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Provides an IAM role.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 resource "aws_iam_role" "replication" {
   name = "s3-bucket-replication-${module.replica_bucket.id}"
 
@@ -160,9 +160,9 @@ resource "aws_iam_role" "replication" {
 POLICY
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Generates an IAM policy in JSON format for use with resources that expect policy documents such as aws_iam_policy.
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 resource "aws_iam_policy" "replication" {
   name = "s3-bucket-replication-${module.replica_bucket.id}"
 
@@ -203,9 +203,9 @@ resource "aws_iam_policy" "replication" {
 POLICY
 }
 
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 ## Attaches a Managed IAM Policy to user(s), role(s), and/or group(s).
-##----------------------------------------------------------------------------------
+##-----------------------------------------------------------------------------
 resource "aws_iam_policy_attachment" "replication" {
   name       = "s3-bucket-replication-${module.replica_bucket.id}"
   roles      = [aws_iam_role.replication.name]