Skip to content
Documentation

GitHub Repositories Naming Conventions | Deployer

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.

Deployer Naming Examples

The structure of the repository names falls into two categories:

  1. General Deployer Repository: tg-aws-deployer-<deployer name>
  2. Customer-Specific Repository: tg-aws-deployer-<customer name>-<deployer name>

Here are some examples:

Good Examples General Deployer Repository:

  • tg-aws-deployer-network (AWS Network deployer)
  • tg-aws-deployer-security (AWS Security deployer)
  • tg-aws-deployer-monitoring (AWS Monitoring deployer)

Avoid Examples General Deployer Repository:

  • tg-aws-deployer_network (underscore instead of dash)
  • TerraGrunt-AWS-Deployer-Network (mixed case)
  • tg-aws-deployer-network-module (redundant “module” in the name)

Good Examples Customer-Specific Repository:

  • tg-aws-deployer-cirrusgo-network (cirrusgo Network deployer)
  • tg-aws-deployer-cirrusgo-security (cirrusgo Security deployer)
  • tg-aws-deployer-cirrusgo-monitoring (cirrusgo Monitoring deployer)

Avoid Examples Customer-Specific Repository:

  • tg-aws-deployer-cirrusgo_network (underscore instead of dash)
  • TerraGrunt-AWS-Deployer-CirrusGo-Network (mixed case)
  • tg-aws-deployer-cirrusgo-network-module (redundant “module” in the name)