Github Naming

Github Resource Naming Conventions #

Please see the Global Resource Naming section for an explanation of each node this naming convention uses and the structure of the naming standard.

Standard Github Template # 

<agency>-<platform>-<product>-[<#description#>-]<project/team>-<env>

<#description#> is used as a short description of functionality of repo. Multiple nodes are allowed. Code can read from front and from back for the five required nodes.

Repositories #

Examples: required nodes shown like this

  • dial-aws-safher-digix-prod
  • dial-aws-safher-digix-nonprod
  • hhs-azc-elias-chatbot-accenture-prod
  • dom-aws-firstname-lastname-team-sbox sandbox accounts are exception, must always have 2 description nodes with names if sbox is the env.
  • dom-aws-naming-terraform-module-infra-prod

Environments #

ghenv stands for GitHub Environment. We use environments when a single repository can deploy to multiple environments.

Examples:

  • ghenv-acct-hhs-aws-elias-chatbot-prod-plan
  • ghenv-rg-dot-azc-connectivity-infra-test-apply
  • ghenv-subcr-hhs-azc-management-infra-nonprod

Roles #

ghrole is the name of the role or id on the cloud platform itself being used by the GitHub runner. These roles live on the platform (AWS/Azure) not in GitHub.

  • ghrole-id-dot-azc-avx-infra-prod-apply-ncus-001
  • ghrole-role-hhs-aws-elias-chatbot-prod-plan-read-034
Edit this page