Skip to content

Commit bbb442b

Browse files
committed
chore: update README.md
1 parent 59584c2 commit bbb442b

File tree

2 files changed

+70
-53
lines changed

2 files changed

+70
-53
lines changed

.github/banner.png

995 KB
Loading

README.md

Lines changed: 70 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1+
2+
13
<!-- markdownlint-disable -->
2-
# github-action-atmos-terraform-select-components <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
3-
<a href="https://github.com/cloudposse/github-action-atmos-terraform-select-components/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-select-components.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-atmos-terraform-select-components/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/>
5+
<p align="right">
6+
<a href="https://github.com/cloudposse/github-action-atmos-terraform-select-components/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-select-components.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a></p>
47
<!-- markdownlint-restore -->
58

69
<!--
@@ -27,16 +30,16 @@
2730
GitHub Action that outputs list of Atmos components by jq query
2831

2932

30-
---
31-
> [!NOTE]
32-
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=) approach towards DevOps.
33-
> <details><summary><strong>Learn More</strong></summary>
33+
> [!TIP]
34+
> #### 👽 Use Atmos with Terraform
35+
> Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. <br/>
36+
> Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).
3437
>
35-
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
36-
>
37-
> </details>
38-
39-
<a href="https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=readme_header_link"><img src="https://cloudposse.com/readme/header/img"/></a>
38+
> <details>
39+
> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary>
40+
> <img src="https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true"/><br/>
41+
> <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i>
42+
> </detalis>
4043
4144

4245
## Introduction
@@ -64,9 +67,8 @@ Output of this action is a list of basic component information. For example:
6467

6568

6669

67-
## Usage
68-
6970

71+
## Usage
7072

7173
### Config
7274

@@ -264,6 +266,14 @@ Which would produce the same behavior as in `v2`, doing this:
264266
Please note that the `atmos-gitops-config-path` is not the same file as the `atmos-config-path`.
265267

266268

269+
> [!IMPORTANT]
270+
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
271+
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
272+
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
273+
> approach for updating versions to avoid unexpected changes.
274+
275+
276+
267277

268278

269279

@@ -287,23 +297,60 @@ For additional context, refer to some of these links.
287297
- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow
288298

289299

300+
301+
> [!TIP]
302+
> #### Use Terraform Reference Architectures for AWS
303+
>
304+
> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.
305+
>
306+
> ✅ We build it together with your team.<br/>
307+
> ✅ Your team owns everything.<br/>
308+
> ✅ 100% Open Source and backed by fanatical support.<br/>
309+
>
310+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
311+
> <details><summary>📚 <strong>Learn More</strong></summary>
312+
>
313+
> <br/>
314+
>
315+
> Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=commercial_support) for funded startups and enterprises.
316+
>
317+
> *Your team can operate like a pro today.*
318+
>
319+
> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
320+
> #### Day-0: Your Foundation for Success
321+
> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
322+
> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
323+
> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
324+
> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
325+
> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
326+
>
327+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
328+
>
329+
> #### Day-2: Your Operational Mastery
330+
> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
331+
> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
332+
> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
333+
> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
334+
> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
335+
> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
336+
> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
337+
>
338+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
339+
> </details>
340+
290341
## ✨ Contributing
291342

292343
This project is under active development, and we encourage contributions from our community.
344+
345+
346+
293347
Many thanks to our outstanding contributors:
294348

295349
<a href="https://github.com/cloudposse/github-action-atmos-terraform-select-components/graphs/contributors">
296350
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-atmos-terraform-select-components&max=24" />
297351
</a>
298352

299-
### 🐛 Bug Reports & Feature Requests
300-
301-
Please use the [issue tracker](https://github.com/cloudposse/github-action-atmos-terraform-select-components/issues) to report any bugs or file feature requests.
302-
303-
### 💻 Developing
304-
305-
If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you!
306-
Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=slack), in the `#cloudposse` channel.
353+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/github-action-atmos-terraform-select-components/issues).
307354

308355
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
309356
1. Review our [Code of Conduct](https://github.com/cloudposse/github-action-atmos-terraform-select-components/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
@@ -328,38 +375,6 @@ Dropped straight into your Inbox every week — and usually a 5-minute read.
328375

329376
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&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.
330377
It's **FREE** for everyone!
331-
332-
## About
333-
334-
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=">Cloud Posse, LLC</a>.
335-
<a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
336-
337-
We are a [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=commercial_support) for funded startups and enterprises.
338-
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
339-
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
340-
341-
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
342-
343-
*Your team can operate like a pro today.*
344-
345-
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
346-
347-
<details>
348-
<summary>📚 <strong>See What's Included</strong></summary>
349-
350-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
351-
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
352-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
353-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
354-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
355-
- **Training.** You'll receive hands-on training so your team can operate what we build.
356-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
357-
- **Troubleshooting.** You'll get help to triage when things aren't working.
358-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
359-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
360-
</details>
361-
362-
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
363378
## License
364379

365380
<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>
@@ -394,6 +409,8 @@ under the License.
394409
## Trademarks
395410

396411
All other trademarks referenced herein are the property of their respective owners.
412+
413+
397414
---
398415
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
399416

0 commit comments

Comments
 (0)