Skip to content

Commit 0497bec

Browse files
committed
chore: update README.md
1 parent 3457190 commit 0497bec

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-codebuild/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-codebuild/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-codebuild.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-codebuild/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-codebuild.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-codebuild/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-codebuild.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-codebuild/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-codebuild.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
<!--
@@ -323,7 +326,36 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
323326
5. **Push** your work back up to your fork
324327
6. Submit a **Pull Request** so that we can review your changes
325328

326-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
329+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!## Running Terraform Tests
330+
331+
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.
332+
333+
All tests are located in the [`test/`](test) folder.
334+
335+
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.
336+
337+
Setup dependencies:
338+
- Install Atmos ([installation guide](https://atmos.tools/install/))
339+
- Install Go [1.24+ or newer](https://go.dev/doc/install)
340+
- Install Terraform or OpenTofu
341+
342+
To run tests:
343+
344+
- Run all tests:
345+
```sh
346+
atmos test run
347+
```
348+
- Clean up test artifacts:
349+
```sh
350+
atmos test clean
351+
```
352+
- Explore additional test options:
353+
```sh
354+
atmos test --help
355+
```
356+
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.
357+
358+
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.
327359

328360
### 🌎 Slack Community
329361

0 commit comments

Comments
 (0)