stackx-template-terraform

Template repository for Terraform used by all our stackx GitHub repositories.

This repo will be synced with the AndreasAugustin/actions-template-sync GitHub Action.

Requirements

Secrets

During setup of the new GitHub repository, set these Secrets for GitHub Actions:

• INFRACOST_API_KEY (Infracost)
• LOCALSTACK_API_KEY (LocalStack)
• PERSONAL_ACCESS_TOKEN (GitHub Personal Access Token with workflow scope)

For modules without LocalStack support, please set LOCALSTACK_API_KEY to false

Diagrams

Add a diagram.py in docs/images to automatically generate a diagram as code.

The required syntax (replace repository-name accordingly:

with Diagram("repository-name", outformat="png", filename="screenshot1", show=False):

README

Create a README.yaml in the docs/ subdirectory, which will be used in the stackx-action-readme-templates GitHub Action to generate the final README.md file.

Pull Request Labels

Add the following labels to your repository if they are not already there:

• chore
• template-sync