|
2 | 2 |
|
3 | 3 | <!-- markdownlint-disable --> |
4 | 4 | <a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-aws-s3-website/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> |
5 | | - <p align="right"> |
6 | | -<a href="https://github.com/cloudposse/terraform-aws-s3-website/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-s3-website.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-s3-website/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-s3-website.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p> |
| 5 | + |
| 6 | + |
| 7 | +<p align="right"><a href="https://github.com/cloudposse/terraform-aws-s3-website/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-s3-website.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-s3-website/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-s3-website.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://cloudposse.com/slack"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a><a href="https://cloudposse.com/support/"><img src="https://img.shields.io/badge/Get_Support-success.svg?style=for-the-badge" alt="Get Support"/></a> |
| 8 | + |
| 9 | +</p> |
7 | 10 | <!-- markdownlint-restore --> |
8 | 11 |
|
9 | 12 | <!-- |
@@ -48,7 +51,7 @@ Terraform module to provision S3-backed Websites. |
48 | 51 | > |
49 | 52 | > <details> |
50 | 53 | > <summary><strong>Watch demo of using Atmos with Terraform</strong></summary> |
51 | | -> <img src="https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true"/><br/> |
| 54 | +> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/><br/> |
52 | 55 | > <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i> |
53 | 56 | > </detalis> |
54 | 57 |
|
@@ -108,18 +111,6 @@ module "website_with_cname" { |
108 | 111 |
|
109 | 112 |
|
110 | 113 |
|
111 | | -<!-- markdownlint-disable --> |
112 | | -## Makefile Targets |
113 | | -```text |
114 | | -Available targets: |
115 | | -
|
116 | | - help Help screen |
117 | | - help/all Display help for all targets |
118 | | - help/short This help short screen |
119 | | - lint Lint terraform code |
120 | | -
|
121 | | -``` |
122 | | -<!-- markdownlint-restore --> |
123 | 114 | <!-- markdownlint-disable --> |
124 | 115 | ## Requirements |
125 | 116 |
|
@@ -221,6 +212,11 @@ Available targets: |
221 | 212 | <!-- markdownlint-restore --> |
222 | 213 |
|
223 | 214 |
|
| 215 | + |
| 216 | + |
| 217 | + |
| 218 | + |
| 219 | + |
224 | 220 | ## Related Projects |
225 | 221 |
|
226 | 222 | Check out these related projects. |
@@ -302,7 +298,36 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. |
302 | 298 | 5. **Push** your work back up to your fork |
303 | 299 | 6. Submit a **Pull Request** so that we can review your changes |
304 | 300 |
|
305 | | -**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request! |
| 301 | +**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!## Running Terraform Tests |
| 302 | + |
| 303 | +We use [Atmos](https://atmos.tools) to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands. |
| 304 | + |
| 305 | +All tests are located in the [`test/`](test) folder. |
| 306 | + |
| 307 | +Under the hood, tests are powered by Terratest together with our internal [Test Helpers](https://github.com/cloudposse/test-helpers) library, providing robust infrastructure validation. |
| 308 | + |
| 309 | +Setup dependencies: |
| 310 | +- Install Atmos ([installation guide](https://atmos.tools/install/)) |
| 311 | +- Install Go [1.24+ or newer](https://go.dev/doc/install) |
| 312 | +- Install Terraform or OpenTofu |
| 313 | + |
| 314 | +To run tests: |
| 315 | + |
| 316 | +- Run all tests: |
| 317 | + ```sh |
| 318 | + atmos test run |
| 319 | + ``` |
| 320 | +- Clean up test artifacts: |
| 321 | + ```sh |
| 322 | + atmos test clean |
| 323 | + ``` |
| 324 | +- Explore additional test options: |
| 325 | + ```sh |
| 326 | + atmos test --help |
| 327 | + ``` |
| 328 | +The configuration for test commands is centrally managed. To review what's being imported, see the [`atmos.yaml`](https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/terraform-module.yaml) file. |
| 329 | + |
| 330 | +Learn more about our [automated testing in our documentation](https://docs.cloudposse.com/community/contribute/automated-testing/) or implementing [custom commands](https://atmos.tools/core-concepts/custom-commands/) with atmos. |
306 | 331 |
|
307 | 332 | ### 🌎 Slack Community |
308 | 333 |
|
@@ -354,7 +379,7 @@ All other trademarks referenced herein are the property of their respective owne |
354 | 379 |
|
355 | 380 |
|
356 | 381 | --- |
357 | | -Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright) |
| 382 | +Copyright © 2017-2025 [Cloud Posse, LLC](https://cpco.io/copyright) |
358 | 383 |
|
359 | 384 |
|
360 | 385 | <a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-website&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a> |
|
0 commit comments