Skip to content

Commit 0375710

Browse files
committed
Add description to README
1 parent 761ad94 commit 0375710

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1-
Terraform module to provide consistent naming
1+
terraform-local-label
22
===
33

4+
Terraform module to provide consistent label names and tags for resources.
5+
6+
A single name format will not solve every use case, so multiple variants are returned and there is a few options to affect how they get build. The general name convention is `{organization}-{environment}-{name}-{attributes}`. `Name` is required, the other 3 can be turned on/off indivisually. The delimiter (`-`) can be changed
7+
8+
All devops-workflow module will eventually use this.
9+
10+
*NOTE:* `local` refers to this using `locals` and does not create any resources. It just builds new variables.
11+
412
Terraform registry: https://registry.terraform.io/modules/devops-workflow/label/local
13+
14+
TODO: Add usage/examples

0 commit comments

Comments
 (0)