Skip to content
Documentation

GitHub Repositories Naming Conventions | Stack

Loading...

Introduction

Consistent and meaningful repository names are crucial for maintaining an organized and easily navigable codebase. The following conventions provide guidelines for naming Terraform AWS module repositories to ensure clarity and uniformity across your projects.

Stack Naming Examples

The structure of the repository names falls into three categories:

  1. General Stack Repository: tf-aws-stack-<stack name>
  2. Customer-Specific Repository: tf-aws-stack-<customer name>-<stack name>
  3. Customer and Environment-Specific Repository: tf-aws-stack-<customer name>-<environment type>-<stack name>

Here are some examples:

Good Examples General Stack Repository:

  • tf-aws-stack-network (AWS Network stack)
  • tf-aws-stack-security (AWS Security stack)
  • tf-aws-stack-monitoring (AWS Monitoring stack)

Avoid Examples General Stack Repository:

  • tf-aws-stack_network (underscore instead of dash)
  • Terraform-AWS-Stack-Network (mixed case)
  • tf-aws-stack-network-module (redundant “module” in the name)

Good Examples Customer-Specific Repository:

  • tf-aws-stack-cirrusgo-network (cirrusgo Network stack)
  • tf-aws-stack-cirrusgo-security (cirrusgo Security stack)
  • tf-aws-stack-cirrusgo-monitoring (cirrusgo Monitoring stack)

Avoid Examples Customer-Specific Repository:

  • tf-aws-stack-cirrusgo_network (underscore instead of dash)
  • Terraform-AWS-Stack-CirrusGo-Network (mixed case)
  • tf-aws-stack-cirrusgo-network-module (redundant “module” in the name)

Good Examples Customer and Environment-Specific Repository:

  • tf-aws-stack-cirrusgo-dev-network (cirrusgo Development Network stack)
  • tf-aws-stack-cirrusgo-prod-security (cirrusgo Production Security stack)
  • tf-aws-stack-cirrusgo-staging-monitoring (cirrusgo Staging Monitoring stack)

Avoid Examples Customer and Environment-Specific Repository:

  • tf-aws-stack-cirrusgo-dev_network (underscore instead of dash)
  • Terraform-AWS-Stack-CirrusGo-Dev-Network (mixed case)
  • tf-aws-stack-cirrusgo-dev-network-module (redundant “module” in the name)