/terraform-aws-s3

Primary LanguageHCL

Terraform Module Template

This template can be used to easily start building your terraform modules.

Workflows

In this template there are 3 github actions workflows:

  • auto_tag.yaml
    • this workflow will run whenever a merge to the main branch occurs
    • it will by default tag your repository with a Patch bump (version format is: vMajor.Minor.Patch)
    • if you want to bump the major or the minor version of the repository, you will simply have to start your commit with #major or #minor
  • pre_commit.yaml
    • this workflow will run on every push in order to check: tflint, tf-docs, validate, fmt, end-of-file fixer and trailing whitspace fixes and whatever else you decide to add to the .pre-commit-config.yaml file
  • terraform.yaml
    • this workflow can be run manually based on an operation you provide (plan, apply, destroy)
    • it is recommended to use remote state in order to take advantage of this

Installing pre-commit locally

In order to make sure that you are writing code that respects industry standards, you will need to install:

After you install all of these, you can go to the root directory of the repository and run:

pre-commit run --all-files

This will fix all the problems related to the hooks mentioned above.

Taking advantage of Terraform-Docs

You will need to add the following in README.md in order to auto-populate the documentation with terraform-docs.

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->