Nando's Terraform Modules

Description

This repository contains Terraform modules for various infrastructure components. We use semantic-release to manage versioning and releases. This repo doesn't contain any information specific to Nando's.

Usage

You can find specific examples and available variables inside each module folder. Here is an example on how to use cloud run v1 module:

module "cloud-run-api-my-awesome-api" {
  source                = "github.com/NandosUK/infrastructure-terraform-modules/gcp/cloud-run-v2"
  project_id                 = "my-gcp-project-id"
  name                       = "my-awesome-api"
  (...)
}

Examples

You can find specific implementation examples under the test folder.

Which API should I use?

Click here to find the different options (Internal Docs)

Contribute

Semantic Release and Commit Message Guidelines

This project uses semantic-release for automated versioning and package publishing. To ensure that the version numbers are updated correctly, we adhere to Conventional Commits guidelines for commit messages.

Commit Message Format

The commit message should be structured as follows:

<type>(<scope>): <subject>

• Type : Indicates the type of change being made. This can be one of the following:
  • feat: A new feature
  • fix: A bug fix
  • chore: Routine tasks or maintenance
  • docs: Documentation changes
  • style: Code style changes (formatting, indentation, etc.)
  • refactor: Code changes that neither fix bugs nor add features
  • perf: Performance improvements
  • test: Adding or modifying tests
• Scope : An optional part that indicates the module or part of the codebase the commit modifies. Specify the individual terraform module.
• Subject : A short description of the change. Keep it concise and to the point.

Examples

• feat(api): add new validation logic
• fix(cloud-run-v1): resolve issue with variable x
• test(utils): add additional unit tests for utils
• docs(cloud-function-v1): update setup instructions

How to Make Commits

1. Make your changes in a new git branch:

git checkout -b my-fix-branch main

2. Commit your changes using a descriptive commit message that follows our commit message guidelines.

git commit -m "fix(auth): resolve login bug"

3. Push your branch to GitHub:

git push origin my-fix-branch

4. If you have pushed commits up to GitHub, you can use the GitHub UI to create a new Pull Request targeting the main branch.