Merge pull request #6 from geekcell/update-templates

docs: update templates

Author: Ic3w0lf

.github/.templatesyncignore

@@ -0,0 +1,9 @@
+README.md
+.github/workflows/*
+.terraform-docs.yml
+docs/20-badges.md
+docs/assets/logo.svg
+*.tf
+test/*
+go.mod
+go.sum

.github/dependabot.yml

@@ -0,0 +1,32 @@
+---
+##############################
+## Dependabot configuration ##
+##############################
+
+#
+# Documentation:
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates
+#
+
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 0
+
+  # Maintain dependencies for Terraform Providers
+  - package-ecosystem: "terraform"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 0
+
+  # Maintain dependencies for Golang
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 0

.github/labels.yaml

@@ -5,10 +5,6 @@
 
 ...
 
-## How this PR fixes it
-
-...
-
 ## Readiness Checklist
 
 ### Author/Contributor

.github/pull_request-template.md

@@ -1,7 +1,7 @@
 ---
-####################################
-## Draft releases on Push to main ##
-####################################
+#####################
+## Create releases ##
+#####################
 
 #
 # Documentation:
@@ -13,9 +13,8 @@ on:
   push:
     branches: [ main ]
     tags: [ 'v*.*.*' ]
-
-permissions:
-  contents: write
+  pull_request:
+    types: [ labeled ]
 
 #################
 # Start the job #
@@ -26,6 +25,7 @@ jobs:
   ###############
   create-release:
     name: Create Release
+    if: github.event.action != 'labeled'
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:
@@ -75,3 +75,22 @@ jobs:
           tag_name: ${{ steps.tag.outputs.value }}
           draft: false
           prerelease: false
+
+  ###########################
+  # Release preview comment #
+  ###########################
+  release-check:
+    if: github.event.action == 'labeled'
+    runs-on: ubuntu-latest
+    steps:
+      ############################
+      # Checkout the source code #
+      ############################
+      - name: Checkout Code
+        uses: actions/checkout@v3.1.0
+
+      #######################
+      # Post status comment #
+      #######################
+      - name: Post bumpr status comment
+        uses: haya14busa/action-bumpr@v1

.github/workflows/release.yaml

@@ -10,7 +10,9 @@
 
 name: Sync templates
 on:
-  workflow_dispatch:
+  workflow_dispatch: # Trigger manually
+  schedule:
+    - cron:  "0 0 1 * *"  # Run at 00:00 on the first day of every month
 
 ##########################
 # Prevent duplicate jobs #
@@ -36,7 +38,7 @@ jobs:
       - name: Sync labels
         uses: EndBug/label-sync@v2.3.1
         with:
-          config-file: https://raw.githubusercontent.com/geekcell/template-terraform-module/main/.github/labels.yaml
+          config-file: https://gist.githubusercontent.com/Ic3w0lf/f5520c5f19d7098966f692c120f7a197/raw/75b134f76fbc55e2e64bd66f04e571d6d74b815e/terraform-aws-module-labels.yaml
 
   #######################
   # Sync template files #
@@ -50,33 +52,12 @@ jobs:
       ############################
       - name: Checkout Code
         uses: actions/checkout@v3.1.0
-        with:
-          token: ${{ secrets.GEEKCELL_PAT_WORKFLOWS }}
-
-      ########################
-      # Patch template files #
-      ########################
-      - name: Force patching of template files
-        run: |
-          yes y | make setup/update-template
-
-      ####################
-      # Update README.md #
-      ####################
-      - name: Terraform docs
-        uses: terraform-docs/gh-actions@v1.0.0
-        with:
-          config-file: .terraform-docs.yml
-          git-push: false
 
-      #############
-      # Create PR #
-      #############
-      - name: Create PR
-        uses: peter-evans/create-pull-request@v4.2.0
+      #######################
+      # Sync template files #
+      #######################
+      - name: actions-template-sync
+        uses: AndreasAugustin/actions-template-sync@v0.7.3
         with:
-          token: ${{ secrets.GEEKCELL_PAT_WORKFLOWS }}
-          title: Updated template files
-          commit-message: Update template files from main repo
-          branch: update-template-files
-          delete-branch: true
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          source_repo_path: geekcell/terraform-aws-module-template

.github/workflows/sync-templates.yaml

@@ -1,24 +1,41 @@
-name: Test
+---
+###############
+## Run tests ##
+###############
+
+#
+# Documentation:
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions
+#
 
+name: Test
 on:
   pull_request:
-  workflow_dispatch:
   push:
     branches: [ main ]
 
-permissions:
-  id-token: write
-  contents: read
-
+##########################
+# Prevent duplicate jobs #
+##########################
 concurrency:
   group: ${{ github.repository }}
   cancel-in-progress: false
 
+permissions:
+  id-token: write
+  contents: read
+
+###############
+# Run the job #
+###############
 jobs:
-  test:
-    name: Terraform Tests
+  terratest:
+    name: Terratest
     runs-on: ubuntu-latest
     steps:
+      ############################
+      # Checkout the source code #
+      ############################
       - name: Checkout
         uses: actions/checkout@v3
 
@@ -32,11 +49,18 @@ jobs:
           aws-region: ${{ vars.AWS_TESTING_REGION }}
           mask-aws-account-id: false
 
+      ################
+      # Setup Golang #
+      ################
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
           go-version-file: 'go.mod'
 
+      #############
+      # Run tests #
+      #############
       - name: Run Tests
+        timeout-minutes: 30
         working-directory: test
-        run: go test -v -timeout 30m
+        run: go test -v

.github/workflows/test.yaml

@@ -1,16 +1,18 @@
 repos:
   - repo: https://github.com/antonbabenko/pre-commit-terraform
-    rev: v1.76.0
+    rev: v1.80.0
     hooks:
       - id: terraform_docs
       - id: terraform_fmt
       - id: terraform_validate
+        args:
+          - --hook-config=--retry-once-with-cleanup=true
         exclude: '^[^/]+$'
       - id: terraform_tflint
         exclude: ^examples/
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.4.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer

.pre-commit-config.yaml

@@ -1,10 +1,14 @@
 formatter: "md table"
 header-from: main.tf
 
+recursive:
+  # Enable this if your module has submodules
+  enabled: false
+
 content: |-
-  {{ include "docs/logo.md" }}
+  {{ include "docs/10-header.md" }}
 
-  {{ include "docs/badges.md" }}
+  {{ include "docs/20-badges.md" }}
 
   {{ .Header }}
 
@@ -20,7 +24,7 @@ content: |-
   {{- end }}
 
   # Examples
-    ### Minimal
+    ### Basic Example
     ```hcl
     {{ include "examples/basic-example/main.tf" }}
     ```

.terraform-docs.yml

@@ -1,15 +1,13 @@
 <!-- BEGIN_TF_DOCS -->
-[![Geek Cell GmbH](https://raw.githubusercontent.com/geekcell/template-terraform-module/main/docs/assets/logo.svg)](https://www.geekcell.io/)
-
-<!--
-Comment in these badges if they apply to the repository.
+[![Geek Cell GmbH](https://raw.githubusercontent.com/geekcell/.github/main/geekcell-github-banner.png)](https://www.geekcell.io/)
 
 ### Code Quality
 [![License](https://img.shields.io/github/license/geekcell/terraform-aws-elasticache-redis-cluster)](https://github.com/geekcell/terraform-aws-elasticache-redis-cluster/blob/master/LICENSE)
 [![GitHub release (latest tag)](https://img.shields.io/github/v/release/geekcell/terraform-aws-elasticache-redis-cluster?logo=github&sort=semver)](https://github.com/geekcell/terraform-aws-elasticache-redis-cluster/releases)
 [![Release](https://github.com/geekcell/terraform-aws-elasticache-redis-cluster/actions/workflows/release.yaml/badge.svg)](https://github.com/geekcell/terraform-aws-elasticache-redis-cluster/actions/workflows/release.yaml)
 [![Validate](https://github.com/geekcell/terraform-aws-elasticache-redis-cluster/actions/workflows/validate.yaml/badge.svg)](https://github.com/geekcell/terraform-aws-elasticache-redis-cluster/actions/workflows/validate.yaml)
 [![Lint](https://github.com/geekcell/terraform-aws-elasticache-redis-cluster/actions/workflows/linter.yaml/badge.svg)](https://github.com/geekcell/terraform-aws-elasticache-redis-cluster/actions/workflows/linter.yaml)
+[![Test](https://github.com/geekcell/terraform-aws-elasticache-redis-cluster/actions/workflows/test.yaml/badge.svg)](https://github.com/geekcell/terraform-aws-elasticache-redis-cluster/actions/workflows/test.yaml)
 
 ### Security
 [![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-elasticache-redis-cluster/general)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-elasticache-redis-cluster&benchmark=INFRASTRUCTURE+SECURITY)
@@ -36,8 +34,6 @@ Comment in these badges if they apply to the repository.
 [![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-elasticache-redis-cluster/hipaa)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-elasticache-redis-cluster&benchmark=HIPAA)
 [![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/geekcell/terraform-aws-elasticache-redis-cluster/fedramp_moderate)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=geekcell%2Fterraform-aws-elasticache-redis-cluster&benchmark=FEDRAMP+%28MODERATE%29)
 
--->
-
 Terraform AWS Elasticache Redis
 
 Introducing the AWS ElastiCache Redis Cluster Terraform Module, a highly efficient solution for creating and managing
@@ -99,25 +95,26 @@ difference it can make in your AWS setup!
 
 ## Resources
 
-- resource.aws_elasticache_replication_group.redis (main.tf#21)
-- resource.random_password.main_password (main.tf#113)
+- resource.aws_elasticache_replication_group.redis (main.tf#20)
+- resource.random_password.main_password (main.tf#118)
 
 # Examples
-### Minimal
+### Basic Example
 ```hcl
 module "vpc" {
   source  = "registry.terraform.io/terraform-aws-modules/vpc/aws"
-  version = "~> 3.19"
-
-  name = "${var.name}-main"
-  cidr = "10.100.0.0/16"
-  azs  = ["eu-central-1a", "eu-central-1b"]
+  version = "~> 5.0.0"
 
+  name                = "${var.name}-main"
+  cidr                = "10.100.0.0/16"
+  azs                 = ["eu-central-1a", "eu-central-1b"]
+  private_subnets     = ["10.100.1.0/24", "10.100.2.0/24"]
   elasticache_subnets = ["10.100.10.0/24", "10.100.11.0/24"]
 }
 
 module "redis_security_group" {
-  source = "github.com/geekcell/terraform-aws-security-group?ref=main"
+  source  = "geekcell/security-group/aws"
+  version = ">= 1.0.0, < 2.0.0"
 
   name   = "${var.name}-redis"
   vpc_id = module.vpc.vpc_id