🛠️ 📚💡 This is a detailed and carefully made template for your GitHub projects. It's based on the wide knowledge and practical experience of the engineering community within NHS England. The template includes helpful suggestions, standards and practices - it's something you should consider using for all your repositories.
As a general rule, the repository template should provide functionality that works out of the box. The terraform example is problematic because the options default to running the example, and the example doesn't give any guidance as to how people should set up their own code.
This patch removes the example, and replaces it with a more fully explained quick start example in Scripting_Terraform.md.
It also adds the TF_ENV environment variable, as a shorthand for selecting the terraform environment directory under infrastructure/environments.
Type of changes
[ ] Refactoring (non-breaking change)
[x] New feature (non-breaking change which adds functionality)
[x] Breaking change (fix or feature that would change existing functionality)
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] This PR is a result of pair or mob programming
Sensitive Information Declaration
To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.
[x] I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.
Description
As a general rule, the repository template should provide functionality that works out of the box. The terraform example is problematic because the options default to running the example, and the example doesn't give any guidance as to how people should set up their own code.
This patch removes the example, and replaces it with a more fully explained quick start example in
Scripting_Terraform.md.It also adds the
TF_ENVenvironment variable, as a shorthand for selecting the terraform environment directory underinfrastructure/environments.Type of changes
Checklist
Sensitive Information Declaration
To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.