Skip to content

Commit f4f225e

Browse files
committed
chore: update README.md
1 parent 425559f commit f4f225e

File tree

1 file changed

+42
-5
lines changed

1 file changed

+42
-5
lines changed

README.md

Lines changed: 42 additions & 5 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-lambda-elasticsearch-cleanup/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-lambda-elasticsearch-cleanup/actions/workflows/lambda.yml"><img src="https://img.shields.io/github/actions/workflow/status/cloudposse/terraform-aws-lambda-elasticsearch-cleanup/lambda.yml?style=for-the-badge" alt="Tests"/></a><a href="https://github.com/cloudposse/terraform-aws-lambda-elasticsearch-cleanup/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-lambda-elasticsearch-cleanup.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-lambda-elasticsearch-cleanup/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-lambda-elasticsearch-cleanup.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://github.com/cloudposse/terraform-aws-lambda-elasticsearch-cleanup/actions/workflows/lambda.yml"><img src="https://img.shields.io/github/actions/workflow/status/cloudposse/terraform-aws-lambda-elasticsearch-cleanup/lambda.yml?style=for-the-badge" alt="Tests"/></a></p>
5+
6+
7+
<p align="right"><a href="https://github.com/cloudposse/terraform-aws-lambda-elasticsearch-cleanup/actions/workflows/lambda.yml"><img src="https://img.shields.io/github/actions/workflow/status/cloudposse/terraform-aws-lambda-elasticsearch-cleanup/lambda.yml?style=for-the-badge" alt="Tests"/></a><a href="https://github.com/cloudposse/terraform-aws-lambda-elasticsearch-cleanup/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-lambda-elasticsearch-cleanup.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-lambda-elasticsearch-cleanup/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-lambda-elasticsearch-cleanup.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://github.com/cloudposse/terraform-aws-lambda-elasticsearch-cleanup/actions/workflows/lambda.yml"><img src="https://img.shields.io/github/actions/workflow/status/cloudposse/terraform-aws-lambda-elasticsearch-cleanup/lambda.yml?style=for-the-badge" alt="Tests"/></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
<!--
@@ -15,8 +18,8 @@
1518
**
1619
** This file was automatically generated by the `cloudposse/build-harness`.
1720
** 1) Make all changes to `README.yaml`
18-
** 2) Run `make init` (you only need to do this once)
19-
** 3) Run`make readme` to rebuild this file.
21+
** 2) Install [atmos](https://atmos.tools/install/) (you only need to do this once)
22+
** 3) Run`atmos readme` to rebuild this file.
2023
**
2124
** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)
2225
**
@@ -51,6 +54,7 @@ topic ARN is given. This module was largely inspired by
5154

5255
## Usage
5356

57+
5458
For a complete example, see [examples/complete](examples/complete).
5559

5660
For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) (which tests and deploys the example on AWS), see [test](test).
@@ -263,7 +267,8 @@ Check out these related projects.
263267
> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
264268
>
265269
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-lambda-elasticsearch-cleanup&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
266-
> </details>
270+
>
271+
</details>
267272
268273
## ✨ Contributing
269274

@@ -289,6 +294,38 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
289294

290295
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
291296

297+
298+
## Running Terraform Tests
299+
300+
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.
301+
302+
All tests are located in the [`test/`](test) folder.
303+
304+
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.
305+
306+
Setup dependencies:
307+
- Install Atmos ([installation guide](https://atmos.tools/install/))
308+
- Install Go [1.24+ or newer](https://go.dev/doc/install)
309+
- Install Terraform or OpenTofu
310+
311+
To run tests:
312+
313+
- Run all tests:
314+
```sh
315+
atmos test run
316+
```
317+
- Clean up test artifacts:
318+
```sh
319+
atmos test clean
320+
```
321+
- Explore additional test options:
322+
```sh
323+
atmos test --help
324+
```
325+
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.
326+
327+
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.
328+
292329
### 🌎 Slack Community
293330

294331
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-lambda-elasticsearch-cleanup&utm_content=slack) on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.

0 commit comments

Comments
 (0)