Initial commit

Author: Kretolus

.github/workflows/main.yml

@@ -0,0 +1,20 @@
+name: Auto-tag
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  tag-new-versions:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 2
+      - uses: salsify/action-detect-and-tag-new-version@v2
+        with:
+          tag-template: "{VERSION}"
+          version-command: |
+            [ -f .version ] && cat .version || echo "v0.0.0"

.gitignore

@@ -0,0 +1,31 @@
+# vim temporaries
+*.sw[p|o|n]
+
+# python bytecode
+*.py[c|o]
+
+# system files
+.zfs
+.DS_Store
+.*.swp
+*~
+
+# Ansible
+*.retry
+
+# Terraform
+.terraform
+*.tfplan
+
+# Directories used by IDEs
+nbproject
+.idea
+.project
+.settings
+
+# SSH Private keys
+*.priv
+
+# Terragrunt
+.terragrunt-cache
+.terraform.lock.hcl

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+  - repo: git://github.com/antonbabenko/pre-commit-terraform
+    rev: v1.48.0
+    hooks:
+      - id: terraform_fmt
+      - id: terraform_docs
+        files: ^.*(.md|.tf|.version)$
+        args:
+          - --args=--config=.terraform-docs.yml
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: end-of-file-fixer

.terraform-docs.yml

@@ -0,0 +1,56 @@
+formatter: markdown table
+
+content: |-
+  {{ .Requirements }}
+  {{ .Modules }}
+  {{ .Providers }}
+  {{ .Resources }}
+  {{ .Inputs }}
+  {{ .Outputs }}
+
+  {{/*  EXAMPLES  */}}{{
+    with $version     := include ".version"
+  }}{{
+    $template         := include "./examples/examples.md"
+  }}{{
+    range $match      := regexFindAll "{{ include \".*\" }}" $template -1
+  }}{{
+    $fileName         := index (regexSplit "\"" $match -1) 1
+  }}{{
+    $template         = replace $match (include (print "./examples/" $fileName)) $template
+  }}{{
+    $template         = replace "{{ provider_version }}" $version $template
+  }}{{
+    end
+  }}{{
+    $template
+  }}{{
+    end
+  }}
+
+
+output:
+  file: "README.md"
+  mode: inject
+  template: |-
+    <!-- START_OF_AUTO_GENERATED_SECTION -->
+    {{ .Content }}
+    <!-- END_OF_AUTO_GENERATED_SECTION -->
+
+sort:
+  enabled: false
+
+settings:
+  anchor: true
+  color: true
+  default: true
+  description: true
+  escape: true
+  hide-empty: true
+  html: true
+  indent: 2
+  lockfile: true
+  read-comments: true
+  required: true
+  sensitive: true
+  type: true

.version

@@ -0,0 +1 @@
+v0.0.1

README.md

@@ -0,0 +1,23 @@
+# template of terraform resource repository
+
+<!-- START_OF_AUTO_GENERATED_SECTION -->
+<!-- END_OF_AUTO_GENERATED_SECTION -->
+
+## Enabling pre-commit hooks
+
+Following pre-commit hooks are provided:
+
+- [terraform-fmt](https://github.com/antonbabenko/pre-commit-terraform#terraform_fmt) to check syntax of terraform
+- [terraform-docs](https://github.com/terraform-docs/terraform-docs) to recreate README.md according to terraform module properties
+- [end-of-file-fixer](https://github.com/pre-commit/pre-commit-hooks#end-of-file-fixer) to ensure that each file ends with newline
+
+### Requirements
+
+- [pre-commit](https://pre-commit.com/#installation)
+
+### Installation
+To install `pre-commit` check .
+
+```bash
+pre-commit install
+```

examples/basic/main.tf

@@ -0,0 +1,6 @@
+## Examples
+
+### Basic example
+```hcl
+{{ include "./basic/main.tf" }}
+```