everything else

Author: sblack4

.github/workflows/pre-commit-check.yaml

@@ -0,0 +1,22 @@
+---
+name: pre-commit-check
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+    runs-on: macOS-latest
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Install prerequisites
+      run: |
+        brew install tfenv tflint terraform-docs pre-commit
+        pre-commit install
+        tfenv install
+    - name: pre-commit run all
+      run: |
+        pre-commit run -a

README.md

@@ -12,13 +12,25 @@ module "example" {
 ## About
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+No requirements.
+
+## Providers
+
+No provider.
+
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| env | Environment to tag resources with | string | `"default"` | no |
-| name | Moniker to apply to all resources in the module | string | n/a | yes |
-| tags | User-Defined tags | map(string) | `{}` | no |
+|------|-------------|------|---------|:--------:|
+| env | Environment to tag resources with | `string` | `"default"` | no |
+| name | Moniker to apply to all resources in the module | `string` | n/a | yes |
+| tags | User-Defined tags | `map(string)` | `{}` | no |
+
+## Outputs
+
+No output.
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 

bin/install-macos.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+echo 'installing brew packages'
+brew install tfenv tflint terraform-docs pre-commit
+
+echo 'installing pre-commit hooks'
+pre-commit install
+
+echo 'installing terraform with tfenv'
+tfenv install

examples/basic/README.md

@@ -0,0 +1,2 @@
+# basic example
+A basic example for this repository

examples/basic/main.tf

@@ -0,0 +1,4 @@
+
+module "example" {
+  source = "../.."
+}

main.tf

@@ -0,0 +1,12 @@
+
+module "tags" {
+  source  = "rhythmictech/tags/terraform"
+  version = "1.0.0"
+
+  enforce_case = "UPPER"
+  tags         = var.tags
+  names = [
+    var.env,
+    var.name
+  ]
+}

outputs.tf

@@ -0,0 +1,17 @@
+
+variable "name" {
+  description = "Moniker to apply to all resources in the module"
+  type        = string
+}
+
+variable "tags" {
+  description = "User-Defined tags"
+  type        = map(string)
+  default     = {}
+}
+
+variable "env" {
+  description = "Environment to tag resources with"
+  type        = string
+  default     = "default"
+}