National Document Repository Infrastructure

This repository is used to build the infrastructure the NDR. That is it's sole purpose. There is no functional code on this repository. Please read the Installation section carefully. You must configure git to use the pre-commit.

Pre-requisites

• Terraform
• Terraform docs

To install terraform-docs on WSL use the following commands (e.g. for v0.20.0):

curl -sSLo ./terraform-docs.tar.gz https://terraform-docs.io/dl/v0.20.0/terraform-docs-v0.20.0-$(uname)-amd64.tar.gz
tar -xzf terraform-docs.tar.gz
chmod +x terraform-docs
sudo mv terraform-docs /usr/local/bin/terraform-docs
rm terraform-docs.tar.gz

Installation

pre-commit hook

As this repository is a standalone infrastructure there is no python/node based pre-commit. Therefore the commit is run but itself. This means that you need to tell git where pre-commits are run from.

• Set this repository to get it's pre-commit hooks from .githooks

git config core.hooksPath .githooks

Pre-commits will run on all commits. This will build docs and format the terraform.