Skip to content

Commit

Permalink
📃 Readme and other docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
vara-bonthu committed Jun 27, 2022
1 parent 2fc482f commit c802548
Show file tree
Hide file tree
Showing 27 changed files with 337 additions and 354 deletions.
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@

### What does this PR do?

<!-- A brief description of the change being made with this pull request. -->


### Motivation

<!-- What inspired you to submit this pull request? -->


### More
- [ ] Yes, I have tested the PR using my local account setup (Provide any test evidence report under Additional Notes)
- [ ] Yes, I ran `pre-commit run -a` with this PR

### For Moderators
- [ ] E2E Test successfully complete before merge?

### Additional Notes

<!-- Anything else we should know when reviewing? -->
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ go.sum

.DS_Store
.idea
.build
.build
6 changes: 3 additions & 3 deletions .header.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ Please include tests to validate your examples/<> root modules, at a minimum. Th

[golang](https://go.dev/doc/install) (for macos you can use `brew`)
2. Change directory into the test folder.

`cd test`
3. Initialize your test

go mod init github.com/[github org]/[repository]

`go mod init github.com/aws-ia/terraform-aws-vpc`
Expand All @@ -54,4 +54,4 @@ For best practices and information on developing with Terraform, see the [I&A Mo

## Continuous Integration

The I&A team uses AWS CodeBuild to perform continuous integration (CI) within the organization. Our CI uses the a repo's `.pre-commit-config.yaml` file as well as some other checks. All PRs with other CI will be rejected. See our [FAQ](https://aws-ia.github.io/standards-terraform/faq/#are-modules-protected-by-ci-automation) for more details.
The I&A team uses AWS CodeBuild to perform continuous integration (CI) within the organization. Our CI uses the a repo's `.pre-commit-config.yaml` file as well as some other checks. All PRs with other CI will be rejected. See our [FAQ](https://aws-ia.github.io/standards-terraform/faq/#are-modules-protected-by-ci-automation) for more details.
47 changes: 38 additions & 9 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,40 @@
---
fail_fast: false
minimum_pre_commit_version: "2.6.0"
repos:
-
repo: https://github.com/aws-ia/pre-commit-configs
# To update run:
# pre-commit autoupdate --freeze
rev: v1.5.0
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.3.0
hooks:
- id: aws-ia-meta-hook
- id: trailing-whitespace
args: ['--markdown-linebreak-ext=md']
- id: end-of-file-fixer
- id: check-merge-conflict
- id: detect-private-key
- id: detect-aws-credentials
args: ['--allow-missing-credentials']
- repo: https://github.com/antonbabenko/pre-commit-terraform
rev: v1.72.2
hooks:
- id: terraform_fmt
- id: terraform_docs
args:
- '--args=--lockfile=false'
- id: terraform_validate
exclude: deploy
- id: terraform_tflint
args:
- '--args=--only=terraform_deprecated_interpolation'
- '--args=--only=terraform_deprecated_index'
- '--args=--only=terraform_unused_declarations'
- '--args=--only=terraform_comment_syntax'
- '--args=--only=terraform_documented_outputs'
- '--args=--only=terraform_documented_variables'
- '--args=--only=terraform_typed_variables'
- '--args=--only=terraform_module_pinned_source'
- '--args=--only=terraform_naming_convention'
- '--args=--only=terraform_required_version'
- '--args=--only=terraform_required_providers'
- '--args=--only=terraform_standard_module_structure'
- '--args=--only=terraform_workspace_remote'
- id: terraform_tfsec
files: ^examples/ # only scan `examples/*` which are the implementation
args:
- --args=--config-file=__GIT_WORKING_DIR__/tfsec.yaml
- --args=--concise-output
20 changes: 0 additions & 20 deletions .terraform-docs.yaml

This file was deleted.

66 changes: 0 additions & 66 deletions .tflint.hcl

This file was deleted.

39 changes: 0 additions & 39 deletions .tfsec/launch_configuration_imdsv2_tfchecks.json

This file was deleted.

39 changes: 0 additions & 39 deletions .tfsec/launch_template_imdsv2_tfchecks.json

This file was deleted.

27 changes: 0 additions & 27 deletions .tfsec/no_launch_config_tfchecks.json

This file was deleted.

27 changes: 0 additions & 27 deletions .tfsec/sg_no_embedded_egress_rules_tfchecks.json

This file was deleted.

27 changes: 0 additions & 27 deletions .tfsec/sg_no_embedded_ingress_rules_tfchecks.json

This file was deleted.

2 changes: 1 addition & 1 deletion CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @aws-ia/aws-ia @vara-bonthu
* @aws-ia/aws-ia @vara-bonthu
4 changes: 4 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## Code of Conduct
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
[email protected] with any additional questions or comments.
Loading

0 comments on commit c802548

Please sign in to comment.