Modernize module for Terraform Registry compliance

[mikmorley]

This pull request introduces several major improvements to the Terraform AWS Secure S3 Website with CloudFront module, focusing on enhanced security, production readiness, developer experience, and documentation. The changes include a comprehensive rewrite of the README.md, the addition of CI/CD validation workflows, improved S3 bucket management, and new example usage files. These updates make the module easier to use, more secure by default, and better documented for end users.

Documentation and Developer Experience:

• Completely rewrote README.md to include detailed usage instructions, feature highlights, architecture overview, input/output tables, security considerations, deployment steps, and support/contribution info. Added badges for CI status, license, and provider compatibility.
• Added a examples/basic/README.md and corresponding Terraform files (main.tf, outputs.tf) to provide a clear, working usage example for new users. [1] [2] [3]

Continuous Integration and Validation:

• Added .github/workflows/terraform-validation.yml to automate Terraform formatting, validation, and security scanning (with tfsec) on pull requests and pushes. This workflow also comments results on PRs and blocks merges on validation failures.

Security and S3 Bucket Management:

• Refactored S3 bucket resource creation: split out versioning, ACL, ownership controls, and public access block into separate resources. Enhanced bucket policy to explicitly allow CloudFront OAI and AWS account root, and to explicitly deny all public access except for allowed principals. [1] [2]
• Fixed S3 object resource naming and bucket selection for initial website files, ensuring compatibility with both new and existing buckets.

Outputs and Provider Requirements:

• Expanded and clarified Terraform outputs to include CloudFront distribution ID, S3 bucket ARN, domain name, and origin access identity ID for easier integration and debugging.
• Removed legacy provider constraint in providers.tf to allow for newer AWS provider versions, aligning with updated documentation.

Minor Improvements:

• Cleaned up formatting in locals block for MIME types in main.tf.

These changes collectively make the module more secure, easier to use, and better supported for production deployments.

---

Features & Documentation

• Major rewrite of README.md with feature highlights, usage examples, architecture, input/output tables, security, and contribution info.
• Added full example usage in examples/basic including README, main.tf, and outputs for quick start and custom domain configuration. [1] [2] [3]

CI/CD & Validation

• Added GitHub Actions workflow for Terraform validation, formatting, and security scanning, with automated PR commenting and blocking on validation errors. (.github/workflows/terraform-validation.yml)

Security & S3 Management

• Refactored S3 bucket resources: separated ACL, versioning, ownership controls, public access block, and improved bucket policy to allow CloudFront OAI and AWS root, and deny public access. [1] [2]
• Fixed S3 object resource and bucket selection for initial website files.

Outputs & Provider

• Expanded outputs for CloudFront and S3 resources, and removed legacy provider constraint for AWS. [1] [2]

Minor

• Cleaned up MIME types formatting in locals block.

[github-actions]

Terraform Validation Results ❌

Format Check 🖌️failure

Initialization ⚙️success

Validation 🤖success

Plan 📖failure

Show Validation Errors

Pusher: @mikmorley, Action: pull_request

[github-actions]

Terraform Validation Results ❌

Format Check 🖌️failure

Initialization ⚙️success

Validation 🤖success

Plan 📖failure

Show Validation Errors

Pusher: @mikmorley, Action: pull_request

[github-actions]

Terraform Validation Results ❌

Format Check 🖌️failure

Initialization ⚙️success

Validation 🤖success

Plan 📖success

Show Validation Errors

Pusher: @mikmorley, Action: pull_request

[github-actions]

Terraform Validation Results ❌

Format Check 🖌️failure

Initialization ⚙️success

Validation 🤖success

Plan 📖success

Show Validation Errors

Pusher: @mikmorley, Action: pull_request

[github-actions]

Terraform Validation Results ✅

Format Check 🖌️success

Initialization ⚙️success

Validation 🤖success

Plan 📖success

Show Plan

Plan skipped in CI environment

Pusher: @mikmorley, Action: pull_request

[Copilot]

Pull Request Overview

This PR modernizes the Terraform module for AWS Secure S3 Website with CloudFront to achieve Terraform Registry compliance and production readiness. The changes focus on enhanced security, comprehensive documentation, CI/CD automation, and improved developer experience.

Key changes include:

• Complete rewrite of documentation with detailed usage examples, architecture overview, and comprehensive input/output tables
• Addition of CI/CD validation workflows for automated testing and security scanning
• Refactoring of S3 bucket management with improved security policies and resource separation

Reviewed Changes

Copilot reviewed 10 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
versions.tf	New file establishing Terraform and AWS provider version requirements
variables.tf	Enhanced variable definitions with validation rules and improved descriptions
providers.tf	Removed legacy provider constraints to support newer AWS provider versions
outputs.tf	Expanded outputs with descriptions and improved conditional logic for bucket handling
main.tf	Refactored S3 bucket resources, improved security policies, and cleaned up MIME type formatting
examples/basic/	Added comprehensive example with README, main.tf, and outputs for quick start usage
README.md	Complete rewrite with detailed documentation, usage examples, and architecture overview
.github/workflows/terraform-validation.yml	New CI/CD workflow for automated validation, formatting, and security scanning