Skip to content

Commit 046f0b6

Browse files
committed
chore: update README.md
1 parent 393f5a1 commit 046f0b6

File tree

2 files changed

+37
-22
lines changed

2 files changed

+37
-22
lines changed

.github/banner.png

984 KB
Loading

README.md

Lines changed: 37 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11

22

33
<!-- markdownlint-disable -->
4-
# github-action-docker-image-exists <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-image-exists&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
5-
<a href="https://github.com/cloudposse/github-action-docker-image-exists/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-docker-image-exists.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
4+
<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/github-action-docker-image-exists/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/>
5+
6+
7+
<p align="right"><a href="https://github.com/cloudposse/github-action-docker-image-exists/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-docker-image-exists.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/github-action-docker-image-exists/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/github-action-docker-image-exists.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>
8+
9+
</p>
610
<!-- markdownlint-restore -->
711

812
<!--
@@ -69,28 +73,10 @@ Check if docker image exists by pulling it
6973
7074
7175
72-
<!-- markdownlint-disable -->
7376
74-
## Inputs
7577
76-
| Name | Description | Default | Required |
77-
|------|-------------|---------|----------|
78-
| image\_name | Image name (excluding registry). Defaults to {{$organization/$repository}}. | | false |
79-
| login | Docker login | | false |
80-
| organization | Organization | N/A | true |
81-
| password | Docker password | | false |
82-
| registry | Docker registry | N/A | true |
83-
| repository | Repository | N/A | true |
84-
| tag | Tag | N/A | true |
8578
8679
87-
## Outputs
88-
89-
| Name | Description |
90-
|------|-------------|
91-
| image | Docker image name |
92-
| tag | Docker image tag |
93-
<!-- markdownlint-restore -->
9480
9581
9682
## Related Projects
@@ -132,7 +118,36 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
132118
5. **Push** your work back up to your fork
133119
6. Submit a **Pull Request** so that we can review your changes
134120
135-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
121+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!## Running Terraform Tests
122+
123+
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.
124+
125+
All tests are located in the [`test/`](test) folder.
126+
127+
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.
128+
129+
Setup dependencies:
130+
- Install Atmos ([installation guide](https://atmos.tools/install/))
131+
- Install Go [1.24+ or newer](https://go.dev/doc/install)
132+
- Install Terraform or OpenTofu
133+
134+
To run tests:
135+
136+
- Run all tests:
137+
```sh
138+
atmos test run
139+
```
140+
- Clean up test artifacts:
141+
```sh
142+
atmos test clean
143+
```
144+
- Explore additional test options:
145+
```sh
146+
atmos test --help
147+
```
148+
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.
149+
150+
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.
136151

137152
### 🌎 Slack Community
138153

@@ -184,7 +199,7 @@ All other trademarks referenced herein are the property of their respective owne
184199

185200

186201
---
187-
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
202+
Copyright © 2017-2025 [Cloud Posse, LLC](https://cpco.io/copyright)
188203

189204

190205
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-image-exists&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>

0 commit comments

Comments
 (0)