# tf-scaffold This repository exists to help with new terraform projects, and with automation and training. The repository is designed to create the structure- scaffold that is alway needed for a new Terraform project. Included are the basic Github Actions. To clone scaffold repository but with no .git folder. ## Powershell ```powershell git clone --depth=1 git@github.com:JamesWoolfenden/tf-scaffold.git scaffold rm scaffold\.git -recurse -force ``` Edit your profile and add: ```powershell function scaffold { param( [parameter(mandatory=$true)] [string]$name, [string]$branch="master") git clone --depth=1 --branch=$branch git@github.com:JamesWoolfenden/tf-scaffold.git "$name" rm "$name\.git" -recurse -force } ``` or ```powershell function scaffold { param( [parameter(mandatory=$true)] [string]$name, [string]$branch="master", [switch]$repo=$false) if (!(test-path .\$name)) { git clone --depth=1 --branch=$branch git@github.com:JamesWoolfenden/tf-scaffold.git "$name" } else{ write-warning "Path $name already exists" return } rm "$name\.git" -recurse -force cd $name echo "# %name" >README.md if ($repo) { git init|git add -A pre-commit install git commit -m "Initial Draft" } } ``` Then you can use: ```powershell scaffold -name hello-world ``` or to start a new git repo as well: ```powershell scaffold -name hello-world -repo ``` To make a new project anytime you like. ## \*Nix ```cli git clone --depth=1 git@github.com:JamesWoolfenden/tf-scaffold.git scaffold| rm !$/.git -rf ``` Or you add this to your ~/.bashrc ```bash function scaffold() { if [ -z "$1" ] then name="scaffold" else name=$1 fi if [ -z "$2" ] then branch="master" else branch=$2 fi echo "git clone --depth=1 --branch $branch git@github.com:JamesWoolfenden/tf-scaffold.git $name" git clone --depth=1 --branch $branch git@github.com:JamesWoolfenden/tf-scaffold.git $name rm $name/.git -rf } ``` ## Usage Once it's in your profile, pretty straigh forward: ```cli $ scaffold terraform-aws-generic git clone --depth=1 git@github.com:JamesWoolfenden/tf-scaffold.git terraform-aws-generic Cloning into 'terraform-aws-generic'... remote: Enumerating objects: 14, done. remote: Counting objects: 100% (14/14), done. remote: Compressing objects: 100% (9/9), done. remote: Total 14 (delta 0), reused 10 (delta 0), pack-reused 0 Receiving objects: 100% (14/14), done. ``` ## So what's in it ### .gitignore Has good defaults for working with Terraform ### .pre-commit-config.yaml Has a standard set of pre-commit hooks for working with Terraform and AWS. You'll need to install the pre-commit framework . And after youve added all these file to your new repo, in the root of your new repository: ```cli pre-commit install ``` ### main.tf This is an expected file for Terraform modules. I don't use it. ### Makefile This is just to make like easier for you. Problematic if you are cross platform as make isn't very good/awful at that. ### outputs.tf A standard place to return values, either to the screen or to pass back from a module. ### provider.aws.tf You are always going to be using these, I have added the most basic provider for AWS. ### README.md Where all the information goes. ### main.auto.tfvars This is the standard file for setting your variables in. The auto keyword ensures its picked up and used by Terraform. ### variables.tf Contains a map variable **common_tags** which should be extended and used on every taggable object. ### .dependsabot/config.yml Sets the repository to be automatically dependency scanned in github. ## terraform-docs If you leave the section below in your **README.md** then the pre-commit will auto update your docs. ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| | common\_tags | This is to help you add tags to your cloud objects | map | n/a | yes | # terraform-aws-aurora