Skip to content

Commit b95bd2c

Browse files
authored
fix: Changes found by pre-commit (#381)
* docs: Add terraform-docs link * fix: typos * fix: ignore false-positive secret * fix: trailing whitespace
1 parent b0e83cd commit b95bd2c

25 files changed

Lines changed: 41 additions & 39 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ These modules are intended for Mozilla usage internally. They are not built or s
99
### Pre-commit Checks
1010
This repository uses [pre-commit](https://pre-commit.com/) for running some pre-git-commit checks. Install pre-commit locally (see link for instructions) for your own workspace to also run these checks on every git commit. Pipenv files are included optionally if you use such tooling for managing your pre-commit (or other Python packages) installation.
1111

12+
To run documentation checks, you will need to install [terraform-docs](https://terraform-docs.io/).
13+
1214
This repository also uses [GitHub Actions](.github/workflows/ci.yaml) to run stateless (e.g. no Terraform state or provider connections required) automated checks, including the following:
1315
* terraform fmt --recursive & terraform validate for each module directory;
1416
* for each module (top level subdirectory):

aws_gke_oidc_config/main.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
/*
2-
* # AWS-GKE OIDC Config
1+
/*
2+
* # AWS-GKE OIDC Config
33
* This module will create an AWS OIDC config that creates a trust relationship between a GKE cluster & AWS account.
44
*
55
* Once this module has been invoked for a given account + GKE cluster, the `aws_gke_oidc_role` module can be used

aws_gke_oidc_config/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Required
1+
### Required
22

33
variable "gcp_region" {
44
description = "GKE cluster's GCP region"

aws_gke_oidc_role/.terraform-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ content: |-
66
```hcl
77
{{ include "examples/role_and_config/main.tf" }}
88
```
9-
9+
1010
```hcl
1111
{{ include "examples/role_with_policy/main.tf" }}
1212
```

aws_gke_oidc_role/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## 1.0.0
1+
## 1.0.0
22

33
## 0.1.0
44
* PR [#239](https://github.com/mozilla/terraform-modules/pull/239) - feat: add aws_gke_oidc_config and aws_gke_oidc_role modules

aws_gke_oidc_role/main.tf

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
/*
2-
* # AWS-GKE OIDC Role
1+
/*
2+
* # AWS-GKE OIDC Role
33
* This module will create an AWS role that will allow a specified GKE service account to assume it.
44
*
55
* Requires that `../aws_gke_oidc_config` has been applied for a given AWS account + GKE cluster combination
6-
* if you get an error about the `aws_iam_openid_connect_provider` data source being missing, apply that module.
6+
* if you get an error about the `aws_iam_openid_connect_provider` data source being missing, apply that module.
77
*
8-
* After creating these resources, add the following environment variables, volumes, and volume mounts to your pod definition:
8+
* After creating these resources, add the following environment variables, volumes, and volume mounts to your pod definition:
99
* * env:
1010
* ```
1111
* - name: AWS_REGION

aws_gke_oidc_role/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Required
1+
### Required
22

33
variable "iam_policy_arns" {
44
description = "One or more policy arns to attach to created AWS role"

google_cdn_backend_bucket/main.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
* # google_cdn_backend_bucket
3-
*
3+
*
44
* this module builds a GCP Load Balancer with a backend bucket
55
*/
66

google_cloudsql_postgres/.terraform-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ content: |-
1515
1616
{{ .Inputs }}
1717
18-
{{ .Outputs }}
18+
{{ .Outputs }}
1919

google_cloudsql_postgres/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,5 +169,5 @@ module "postgres_database" {
169169
| <a name="output_replica_public_ip_address"></a> [replica\_public\_ip\_address](#output\_replica\_public\_ip\_address) | n/a |
170170
| <a name="output_self_link"></a> [self\_link](#output\_self\_link) | n/a |
171171
| <a name="output_service_account"></a> [service\_account](#output\_service\_account) | n/a |
172-
| <a name="output_tier"></a> [tier](#output\_tier) | n/a |
172+
| <a name="output_tier"></a> [tier](#output\_tier) | n/a |
173173
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)