aws-ia/copier-terraform-repo-template

Copier Terraform Module

This project is a copier template for creating Terraform projects and modules.

The copier template provided here is used to stamp out the GitHub repository template: aws-ia/terraform-repo-template.

Prerequisites

This project template uses the copier framework to facilitate project generation. Copier is a Python CLI and library for rendering project templates.

In order to use this template (and copier, generally), you must first install Python, git, and the copier module.

• Download & Install Python 3.7+
• Download & Install Git
• Install copier (pip install copier)

Note: Please refer to the official Copier documentation if you encounter difficulty here.

Usage

This project generation template can be used by first installing the pre-requisites annotated above, followed by direct usage of this repository (depending on intended usecase):

CLI

# Directly against GitHub repository using HTTPS
copier "https://github.com/aws-ia/copier-terraform-repo-template.git" target/project/path

# or directly against GitHub using the gh shortcut
copier "gh:aws-ia/copier-terraform-repo-template" target/project/path

Programmatically (Python)

from copier import run_auto

# Create a project from this upstream GitHub repository
run_auto("https://github.com/aws-ia/copier-terraform-repo-template.git", "target/project/pathn")

# You can also use "gh:" as a shortcut of "https://github.com/"
run_auto("gh:aws-ia/copier-terraform-repo-template", "target/project/path")

Note: Please refer to the official Copier documentation for further information on using copier either programmatically or via the CLI here.

copier-terraform-repo-template's Issues

Copier 5.x / 6.x Compatibility

Copier recently released the new major 6.x which (as of 6.0) modifies the jinja2 templating patterns (notably from brackets to braces).
This causes incompatibility issues if _envops configuration isn't explicitly set.
Per the copier documentation, backwards compatibility with 5.x can be achieved by explicitly setting the block_, comment_, and variable_ values for start and end string configuration values.

ref: https://copier.readthedocs.io/en/stable/configuring/#envops

Need doc section on updating repos

1. how can we update certain files in repos that have new commits ontop of the template git log?
2. how can we avoid updating certain files?

• dont want to update someones .header.md or readme.md, etc

Implement initial Copier template

The goal of this repo is to provide a copier template that can be used to stamp out projects/repositories specifically for building Terraform projects and modules. This includes the capability to stamp out the https://github.com/aws-ia/terraform-repo-template template.

The initial copier changes must be introduced in order to accommodate for copier routines.