Skip to content

Commit c4affc0

Browse files
committed
chore: update README.md
1 parent f696b16 commit c4affc0

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,11 @@
22

33
<!-- markdownlint-disable -->
44
<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-aws-tfstate-backend/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-tfstate-backend/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-tfstate-backend.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-tfstate-backend/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-tfstate-backend.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></p>
5+
6+
7+
<p align="right"><a href="https://github.com/cloudposse/terraform-aws-tfstate-backend/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-tfstate-backend.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-tfstate-backend/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-tfstate-backend.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>
710
<!-- markdownlint-restore -->
811

912
<!--
@@ -391,7 +394,36 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
391394
5. **Push** your work back up to your fork
392395
6. Submit a **Pull Request** so that we can review your changes
393396

394-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
397+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!## Running Terraform Tests
398+
399+
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.
400+
401+
All tests are located in the [`test/`](test) folder.
402+
403+
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.
404+
405+
Setup dependencies:
406+
- Install Atmos ([installation guide](https://atmos.tools/install/))
407+
- Install Go [1.24+ or newer](https://go.dev/doc/install)
408+
- Install Terraform or OpenTofu
409+
410+
To run tests:
411+
412+
- Run all tests:
413+
```sh
414+
atmos test run
415+
```
416+
- Clean up test artifacts:
417+
```sh
418+
atmos test clean
419+
```
420+
- Explore additional test options:
421+
```sh
422+
atmos test --help
423+
```
424+
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.
425+
426+
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.
395427

396428
### 🌎 Slack Community
397429

0 commit comments

Comments
 (0)