Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Standardize Comments #48

Merged
merged 2 commits into from
Oct 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/auto_assignee.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
16 changes: 8 additions & 8 deletions .github/workflows/tf-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/'
2 changes: 1 addition & 1 deletion .github/workflows/tflint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
2 changes: 1 addition & 1 deletion .github/workflows/tfsec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: '.'
20 changes: 10 additions & 10 deletions _example/complete/example.tf
Original file line number Diff line number Diff line change
@@ -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"
}
Expand All @@ -12,9 +12,9 @@ locals {
}

data "aws_canonical_user_id" "current" {}
##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
## Provides details about a specific S3 bucket.
##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
module "logging_bucket" {
source = "./../../"

Expand Down Expand Up @@ -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"
Expand All @@ -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 {
Expand All @@ -84,9 +84,9 @@ data "aws_iam_policy_document" "default" {
}
}

##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
## Provides details about a specific S3 bucket.
##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
module "s3_bucket" {
source = "./../../"

Expand Down
8 changes: 4 additions & 4 deletions _example/cors_s3/example.tf
Original file line number Diff line number Diff line change
@@ -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"
}
Expand All @@ -10,9 +10,9 @@ locals {
label_order = ["name", "environment"]
}

##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
## Provides details about a specific S3 bucket.
##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
module "s3_bucket" {
source = "./../../"

Expand Down
8 changes: 4 additions & 4 deletions _example/default-s3/example.tf
Original file line number Diff line number Diff line change
@@ -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"
}
Expand All @@ -10,9 +10,9 @@ locals {
label_order = ["name", "environment"]
}

##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
## Provides details about a default S3 bucket.
##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
module "s3_bucket" {
source = "./../../"

Expand Down
16 changes: 8 additions & 8 deletions _example/encryption-s3/example.tf
Original file line number Diff line number Diff line change
@@ -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"
}
Expand All @@ -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"
Expand All @@ -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 {
Expand All @@ -45,9 +45,9 @@ data "aws_iam_policy_document" "default" {
}
}

##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
## Provides details about a specific S3 bucket.
##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
module "s3_bucket" {
source = "./../../"

Expand Down
20 changes: 10 additions & 10 deletions _example/logging-encryption-s3/example.tf
Original file line number Diff line number Diff line change
@@ -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"
}
Expand All @@ -10,9 +10,9 @@ locals {
label_order = ["name", "environment"]
}

##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
## Provides details about a logging S3 bucket.
##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
module "logging_bucket" {
source = "./../../"

Expand All @@ -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"
Expand All @@ -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 {
Expand All @@ -58,9 +58,9 @@ data "aws_iam_policy_document" "default" {
}
}

##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
## Provides details about a specific S3 bucket.
##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
module "s3_bucket" {
source = "./../../"

Expand Down
12 changes: 6 additions & 6 deletions _example/logging-s3/example.tf
Original file line number Diff line number Diff line change
@@ -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"
}
Expand All @@ -10,9 +10,9 @@ locals {
label_order = ["name", "environment"]
}

##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
## Provides details about a logging S3 bucket.
##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
module "logging_bucket" {
source = "./../../"

Expand All @@ -23,9 +23,9 @@ module "logging_bucket" {
acl = "log-delivery-write"
}

##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
## Provides details about a specific S3 bucket.
##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
module "s3_bucket" {
source = "./../../"

Expand Down
28 changes: 14 additions & 14 deletions _example/s3-replication/example.tf
Original file line number Diff line number Diff line change
@@ -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"
}
Expand All @@ -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 = "../../"

Expand All @@ -42,9 +42,9 @@ module "replica_bucket" {
acl = "private"
versioning = true
}
##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
## Provides details about a specific S3 bucket.
##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
module "s3_bucket" {
source = "../../"

Expand Down Expand Up @@ -137,9 +137,9 @@ module "s3_bucket" {
}
}

##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
## Provides an IAM role.
##----------------------------------------------------------------------------------
##-----------------------------------------------------------------------------
resource "aws_iam_role" "replication" {
name = "s3-bucket-replication-${module.replica_bucket.id}"

Expand All @@ -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}"

Expand Down Expand Up @@ -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]
Expand Down
Loading