Skip to content

Commit c9620e7

Browse files
committed
chore: update README.md
1 parent 609bded commit c9620e7

File tree

2 files changed

+64
-176
lines changed

2 files changed

+64
-176
lines changed

.github/banner.png

976 KB
Loading

README.md

Lines changed: 64 additions & 176 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11

2+
23
<!-- markdownlint-disable -->
3-
# github-action-docker-promote [![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-docker-promote.svg)](https://github.com/cloudposse/github-action-docker-promote/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
4-
<!-- markdownlint-restore -->
4+
<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/github-action-docker-promote/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/>
55

6-
[![README Header][readme_header_img]][readme_header_link]
76

8-
[![Cloud Posse][logo]](https://cpco.io/homepage)
7+
<p align="right"><a href="https://github.com/cloudposse/github-action-docker-promote/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-docker-promote.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/github-action-docker-promote/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/github-action-docker-promote.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>
10+
<!-- markdownlint-restore -->
911

1012
<!--
1113
@@ -14,7 +16,7 @@
1416
1517
** DO NOT EDIT THIS FILE
1618
**
17-
** This file was automatically generated by the `build-harness`.
19+
** This file was automatically generated by the `cloudposse/build-harness`.
1820
** 1) Make all changes to `README.yaml`
1921
** 2) Run `make init` (you only need to do this once)
2022
** 3) Run`make readme` to rebuild this file.
@@ -30,29 +32,6 @@
3032

3133
Promote docker image
3234

33-
---
34-
35-
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
36-
[<img align="right" title="Share via Email" src="https://docs.cloudposse.com/images/ionicons/ios-email-outline-2.0.1-16x16-999999.svg"/>][share_email]
37-
[<img align="right" title="Share on Google+" src="https://docs.cloudposse.com/images/ionicons/social-googleplus-outline-2.0.1-16x16-999999.svg" />][share_googleplus]
38-
[<img align="right" title="Share on Facebook" src="https://docs.cloudposse.com/images/ionicons/social-facebook-outline-2.0.1-16x16-999999.svg" />][share_facebook]
39-
[<img align="right" title="Share on Reddit" src="https://docs.cloudposse.com/images/ionicons/social-reddit-outline-2.0.1-16x16-999999.svg" />][share_reddit]
40-
[<img align="right" title="Share on LinkedIn" src="https://docs.cloudposse.com/images/ionicons/social-linkedin-outline-2.0.1-16x16-999999.svg" />][share_linkedin]
41-
[<img align="right" title="Share on Twitter" src="https://docs.cloudposse.com/images/ionicons/social-twitter-outline-2.0.1-16x16-999999.svg" />][share_twitter]
42-
43-
44-
45-
46-
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
47-
48-
49-
50-
51-
52-
53-
54-
55-
5635

5736

5837

@@ -64,11 +43,8 @@ Promote Docker image to specific tags provided explicitly or implicitly with
6443

6544

6645

67-
6846
## Usage
6947

70-
71-
7248
### Promote a docker image to specific tag
7349

7450
```yaml
@@ -190,38 +166,9 @@ If you skip `from` tag then it would be populated as SHA of the current commit i
190166
191167
192168
193-
<!-- markdownlint-disable -->
194-
195-
## Inputs
196-
197-
| Name | Description | Default | Required |
198-
|------|-------------|---------|----------|
199-
| from | Source tag | N/A | false |
200-
| image\_name | Image name (excluding registry). Defaults to {{$organization/$repository}}. | | false |
201-
| login | Docker login | | false |
202-
| organization | Organization | N/A | true |
203-
| password | Docker password | | false |
204-
| registry | Docker registry | N/A | true |
205-
| repository | Repository | N/A | true |
206-
| to | Target tags | N/A | false |
207-
| use\_metadata | Extract target tags from Git reference and GitHub events | true | false |
208-
209-
210-
## Outputs
211-
212-
| Name | Description |
213-
|------|-------------|
214-
| image | Docker image name |
215-
| tag | Docker image tag |
216-
<!-- markdownlint-restore -->
217-
218169
219170
220-
## Share the Love
221171
222-
Like this project? Please give it a ★ on [our GitHub](https://github.com/cloudposse/github-action-docker-promote)! (it helps us **a lot**)
223-
224-
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
225172
226173
227174
@@ -242,86 +189,84 @@ For additional context, refer to some of these links.
242189
- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow
243190
244191
245-
## Help
246-
247-
**Got a question?** We got answers.
248192
249-
File a GitHub [issue](https://github.com/cloudposse/github-action-docker-promote/issues), send us an [email][email] or join our [Slack Community][slack].
250193
251-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
194+
## ✨ Contributing
252195
253-
## DevOps Accelerator for Startups
196+
This project is under active development, and we encourage contributions from our community.
254197
255198
256-
We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
257199
258-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
200+
Many thanks to our outstanding contributors:
259201
260-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
202+
<a href="https://github.com/cloudposse/github-action-docker-promote/graphs/contributors">
203+
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-docker-promote&max=24" />
204+
</a>
261205
262-
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
206+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/github-action-docker-promote/issues).
263207
264-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
265-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
266-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
267-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
268-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
269-
- **Training.** You'll receive hands-on training so your team can operate what we build.
270-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
271-
- **Troubleshooting.** You'll get help to triage when things aren't working.
272-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
273-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
274-
275-
## Slack Community
276-
277-
Join our [Open Source Community][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.
278-
279-
## Discourse Forums
280-
281-
Participate in our [Discourse Forums][discourse]. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
282-
283-
## Newsletter
284-
285-
Sign up for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
286-
287-
## Office Hours
288-
289-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
290-
291-
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
208+
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
209+
1. Review our [Code of Conduct](https://github.com/cloudposse/github-action-docker-promote/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
210+
2. **Fork** the repo on GitHub
211+
3. **Clone** the project to your own machine
212+
4. **Commit** changes to your own branch
213+
5. **Push** your work back up to your fork
214+
6. Submit a **Pull Request** so that we can review your changes
292215
293-
## Contributing
216+
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!## Running Terraform Tests
294217
295-
### Bug Reports & Feature Requests
218+
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.
296219
297-
Please use the [issue tracker](https://github.com/cloudposse/github-action-docker-promote/issues) to report any bugs or file feature requests.
220+
All tests are located in the [`test/`](test) folder.
298221

299-
### Developing
222+
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.
300223

301-
If you are interested in being a contributor and want to get involved in developing this project or [help out](https://cpco.io/help-out) with our other projects, we would love to hear from you! Shoot us an [email][email].
224+
Setup dependencies:
225+
- Install Atmos ([installation guide](https://atmos.tools/install/))
226+
- Install Go [1.24+ or newer](https://go.dev/doc/install)
227+
- Install Terraform or OpenTofu
302228

303-
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
229+
To run tests:
304230

305-
1. **Fork** the repo on GitHub
306-
2. **Clone** the project to your own machine
307-
3. **Commit** changes to your own branch
308-
4. **Push** your work back up to your fork
309-
5. Submit a **Pull Request** so that we can review your changes
231+
- Run all tests:
232+
```sh
233+
atmos test run
234+
```
235+
- Clean up test artifacts:
236+
```sh
237+
atmos test clean
238+
```
239+
- Explore additional test options:
240+
```sh
241+
atmos test --help
242+
```
243+
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.
310244

311-
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
245+
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.
312246

247+
### 🌎 Slack Community
313248

314-
## Copyright
249+
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&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.
315250

316-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
251+
### 📰 Newsletter
317252

253+
Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=newsletter) and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know.
254+
Dropped straight into your Inbox every week — and usually a 5-minute read.
318255

256+
### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>
319257

258+
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=office_hours) for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q&A_ that you can’t find anywhere else.
259+
It's **FREE** for everyone!
320260
## License
321261

322-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
262+
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>
263+
264+
<details>
265+
<summary>Preamble to the Apache License, Version 2.0</summary>
266+
<br/>
267+
<br/>
323268

324-
See [LICENSE](LICENSE) for full details.
269+
Complete license is available in the [`LICENSE`](LICENSE) file.
325270

326271
```text
327272
Licensed to the Apache Software Foundation (ASF) under one
@@ -341,74 +286,17 @@ KIND, either express or implied. See the License for the
341286
specific language governing permissions and limitations
342287
under the License.
343288
```
344-
345-
346-
347-
348-
349-
350-
351-
289+
</details>
352290

353291
## Trademarks
354292

355293
All other trademarks referenced herein are the property of their respective owners.
356294

357-
## About
358-
359-
This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know by [leaving a testimonial][testimonial]!
360-
361-
[![Cloud Posse][logo]][website]
362-
363-
We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We ❤️ [Open Source Software][we_love_open_source].
364-
365-
We offer [paid support][commercial_support] on all of our projects.
366295

367-
Check out [our other projects][github], [follow us on twitter][twitter], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation.
368-
369-
370-
371-
### Contributors
296+
---
297+
Copyright © 2017-2025 [Cloud Posse, LLC](https://cpco.io/copyright)
372298

373-
<!-- markdownlint-disable -->
374-
| [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] |
375-
|---|
376-
<!-- markdownlint-restore -->
377299

378-
[goruha_homepage]: https://github.com/goruha
379-
[goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png
300+
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
380301

381-
[![README Footer][readme_footer_img]][readme_footer_link]
382-
[![Beacon][beacon]][website]
383-
<!-- markdownlint-disable -->
384-
[logo]: https://cloudposse.com/logo-300x69.svg
385-
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=docs
386-
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=website
387-
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=github
388-
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=jobs
389-
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=hire
390-
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=slack
391-
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=linkedin
392-
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=twitter
393-
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=testimonial
394-
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=office_hours
395-
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=newsletter
396-
[discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=discourse
397-
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=email
398-
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=commercial_support
399-
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=we_love_open_source
400-
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=terraform_modules
401-
[readme_header_img]: https://cloudposse.com/readme/header/img
402-
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=readme_header_link
403-
[readme_footer_img]: https://cloudposse.com/readme/footer/img
404-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=readme_footer_link
405-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
406-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-docker-promote&utm_content=readme_commercial_support_link
407-
[share_twitter]: https://twitter.com/intent/tweet/?text=github-action-docker-promote&url=https://github.com/cloudposse/github-action-docker-promote
408-
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=github-action-docker-promote&url=https://github.com/cloudposse/github-action-docker-promote
409-
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/github-action-docker-promote
410-
[share_facebook]: https://facebook.com/sharer/sharer.php?u=https://github.com/cloudposse/github-action-docker-promote
411-
[share_googleplus]: https://plus.google.com/share?url=https://github.com/cloudposse/github-action-docker-promote
412-
[share_email]: mailto:?subject=github-action-docker-promote&body=https://github.com/cloudposse/github-action-docker-promote
413-
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-docker-promote?pixel&cs=github&cm=readme&an=github-action-docker-promote
414-
<!-- markdownlint-restore -->
302+
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-docker-promote?pixel&cs=github&cm=readme&an=github-action-docker-promote"/>

0 commit comments

Comments
 (0)