Terraform Module Template

GitHub Template Repository for Creating Terraform Modules

Status: Production Ready

Last Updated: 2025-11-14

This is a GitHub template repository for creating new Terraform modules with comprehensive CI/CD, documentation, testing, and best practices built-in.

🚀 Quick Start

Using This Template

1. Click "Use this template" on GitHub to create a new repository
2. Clone your new repository:

   git clone https://github.com/dtlr/your-new-module-name
   cd your-new-module-name

3. Follow the setup guide: See SETUP-GUIDE.md for detailed instructions

What's Included

This template provides:

• ✅ GitHub Actions CI/CD - Validation, linting, security scanning, releases
• ✅ Pre-commit hooks - Automatic formatting and validation
• ✅ Security scanning - tfsec, Checkov, and Trivy integration
• ✅ Documentation generation - terraform-docs automation
• ✅ TFLint configuration - Provider-specific linting rules
• ✅ Example structure - Basic and advanced usage examples
• ✅ Testing framework - Terratest integration setup
• ✅ Semantic versioning - Automated releases with conventional commits

📁 Template Structure

terraform-module-template/
├── .github/workflows/      # CI/CD pipelines
├── docs/                   # Documentation templates
├── examples/               # Usage examples (basic/advanced)
├── tests/                  # Testing framework setup
├── .pre-commit-config.yaml # Pre-commit hooks
├── .terraform-docs.yml     # Documentation generation
├── .tflint.hcl            # Linting configuration
├── README-TEMPLATE.md      # Template for your module README
└── SETUP-GUIDE.md         # Step-by-step setup instructions

🎯 After Using Template

1. Follow SETUP-GUIDE.md - Complete step-by-step setup
2. Implement your module - Create main.tf, variables.tf, outputs.tf, versions.tf
3. Customize README.md - Use README-TEMPLATE.md as starting point
4. Create examples - Add working examples in examples/ directories
5. Configure GitHub secrets - Add provider credentials for CI/CD
6. Test and release - Create your first v1.0.0 release

📖 Documentation

• SETUP-GUIDE.md - Complete setup instructions
• README-TEMPLATE.md - README template for your module
• docs/MIGRATION-GUIDE.md - Migration guide template
• examples/ - Example templates

🏗️ Built-in Best Practices

• Terraform validation and formatting
• Security scanning with multiple tools
• Automated documentation generation
• Semantic versioning with conventional commits
• Integration testing with Terratest
• Provider-specific linting rules

🤝 Contributing

Maintained by DTLR Engineering Team. Submit PRs to improve the template.

---

Ready to create your first Terraform module? Click "Use this template" to get started! 🚀