t04glovern / terraform-repo-template

A pretty good terraform template repository to use as a starter for publicly or privately sharing terraform modules

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

terraform-repo-template

Example template for creating a new Terraform module.

Usage

Basic usage of this module is as follows:

module "example" {
  source = "github.com/t04glovern/terraform-repo-template?ref=v1.0.1"
  prefix = "abcdefg"
}

Commit Structure

More information can be found at Conventional Commits

  • fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
  • feat: feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
  • !: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning).
    • A BREAKING CHANGE can be part of commits of any type.
  • docs: updates to documentation such as a the README or other markdown files
  • ci: continuous integration related
  • chore: changes that do not relate to a fix or feature and don't modify src or test files (for example updating dependencies)

Run Pre-commit

pre-commit run --all-files

Requirements

Name Version
terraform >= 1.0
aws >= 5.0

Providers

Name Version
aws >= 5.0

Modules

No modules.

Resources

Name Type
aws_s3_bucket.example resource

Inputs

Name Description Type Default Required
prefix Prefix for resources string n/a yes

Outputs

No outputs.

About

A pretty good terraform template repository to use as a starter for publicly or privately sharing terraform modules


Languages

Language:HCL 100.0%