Update doc. Add more git pre-commits

Author: Steven Nemetz

.pre-commit-config.yaml

@@ -1,5 +1,41 @@
-- repo: git://github.com/devops-workflow/pre-commit-terraform
-  rev: v1.7.3
-  hooks:
-    - id: terraform_fmt
-    - id: terraform_docs
+# See http://pre-commit.com for more information
+# See http://pre-commit.com/hooks.html for more hooks
+# To update to all latest tagged versions run:
+#     pre-commit autoupdate
+# TODO: write dependencies install instructions and put in each of
+#       my pre-commit repos. Decide where to put for others
+repos:
+  - repo: git://github.com/devops-workflow/pre-commit-terraform
+    # Requires: terraform, terraform-docs
+    rev: v1.7.3
+    hooks:
+      - id: terraform_fmt
+      - id: terraform_docs
+  - repo: git://github.com/pre-commit/pre-commit-hooks
+    rev: v1.2.3
+    hooks:
+      - id: check-merge-conflict
+      - id: trailing-whitespace
+      # - id: end-of-file-fixer
+      - id: check-added-large-files
+      - id: check-yaml
+      # TODO: test these
+      # check-json
+      # pretty-format-json
+      # detect-aws-credentials
+      # detect-private-key
+  #- repo: https://github.com/jumanjihouse/pre-commit-hooks
+  #  # Requires: shellcheck, shfmt
+  #  rev: 1.8.0
+  #  hooks:
+  #    - id: shellcheck
+  #    - id: shfmt
+  #- repo: git://github.com/detailyang/pre-commit-shell
+  #  # Requires: shellcheck
+  #  rev: 1.0.2
+  #  hooks:
+  #    - id: shell-lint
+# TODO:
+# add bashate shell code style https://github.com/openstack-dev/bashate
+# gitlint https://github.com/jorisroovers/gitlint
+# Create new repo and hook for markdown linters

README.md

@@ -1,6 +1,7 @@
 # terraform-local-label
 
 [![CircleCI](https://circleci.com/gh/devops-workflow/terraform-local-label.svg?style=svg)](https://circleci.com/gh/devops-workflow/terraform-local-label)
+[![Github release](https://img.shields.io/github/release/devops-workflow/terraform-local-label.svg)](https://github.com/devops-workflow/terraform-local-label/releases)
 
 Terraform module to provide consistent label names and tags for resources.
 
@@ -91,8 +92,8 @@ module "label" {
 | environment | Environment (ex: `dev`, `qa`, `stage`, `prod`). (Second or top level namespace. Depending on namespacing options) | string | - | yes |
 | monitor | TAG: Should resource be monitored | string | `UNDEF` | no |
 | name | Base name for resource | string | - | yes |
-| namespace-env | Prefix name with the environment. If true, format is: <env>-<name> | string | `true` | no |
-| namespace-org | Prefix name with the organization. If true, format is: <org>-<env namespaced name>. If both env and org namespaces are used, format will be <org>-<env>-<name> | string | `false` | no |
+| namespace-env | Prefix name with the environment. If true, format is: `{env}-{name}` | string | `true` | no |
+| namespace-org | Prefix name with the organization. If true, format is: `{org}-{env namespaced name}`. If both env and org namespaces are used, format will be `{org}-{env}-{name}` | string | `false` | no |
 | organization | Organization name (Top level namespace) | string | `` | no |
 | owner | TAG: Owner of the service | string | `UNDEF` | no |
 | product | TAG: Company/business product | string | `UNDEF` | no |
@@ -111,8 +112,8 @@ module "label" {
 | id_32 | ID truncated to 32 characters |
 | id_attr_20 | ID max size 20 characters by truncating `id_org` then appending `attributes` |
 | id_attr_32 | ID max size 32 characters by truncating `id_org` then appending `attributes` |
-| id_env | If env namespace enabled `env-name` else `name` |
-| id_org | If org namespace enabled `org-id_env` else `id_env` |
+| id_env | If env namespace enabled `{env}-{name}` else `{name}` |
+| id_org | If org namespace enabled `{org}-{id_env}` else `{id_env}` |
 | name | Name lowercase |
 | org_attr_20 | Internal debugging. DO NOT USE |
 | org_attr_32 | Internal debugging. DO NOT USE |

outputs.tf

@@ -34,12 +34,12 @@ output "id_attr_32" {
 }
 
 output "id_env" {
-  description = "If env namespace enabled `env-name` else `name`"
+  description = "If env namespace enabled `{env}-{name}` else `{name}`"
   value       = "${local.id_env}"
 }
 
 output "id_org" {
-  description = "If org namespace enabled `org-id_env` else `id_env`"
+  description = "If org namespace enabled `{org}-{id_env}` else `{id_env}`"
   value       = "${local.id_org}"
 }
 

variables.tf

@@ -33,12 +33,12 @@ variable "name" {
 }
 
 variable "namespace-env" {
-  description = "Prefix name with the environment. If true, format is: <env>-<name>"
+  description = "Prefix name with the environment. If true, format is: `{env}-{name}`"
   default     = true
 }
 
 variable "namespace-org" {
-  description = "Prefix name with the organization. If true, format is: <org>-<env namespaced name>. If both env and org namespaces are used, format will be <org>-<env>-<name>"
+  description = "Prefix name with the organization. If true, format is: `{org}-{env namespaced name}`. If both env and org namespaces are used, format will be `{org}-{env}-{name}`"
   default     = false
 }