Skip to content

Commit 0257b03

Browse files
authored
Update README.md and docs
1 parent 65099c6 commit 0257b03

File tree

1 file changed

+97
-97
lines changed

1 file changed

+97
-97
lines changed

README.md

Lines changed: 97 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
11

2-
<!-- markdownlint-disable -->
3-
# github-action-atmos-terraform-select-components
42

5-
[![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-select-components.svg)](https://github.com/cloudposse/github-action-atmos-terraform-select-components/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
3+
<!-- markdownlint-disable -->
4+
# 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>
5+
<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>
66
<!-- markdownlint-restore -->
77

8-
[![README Header][readme_header_img]][readme_header_link]
9-
10-
[![Cloud Posse][logo]](https://cpco.io/homepage)
11-
128
<!--
139
1410
1511
1612
1713
** DO NOT EDIT THIS FILE
1814
**
19-
** This file was automatically generated by the `build-harness`.
15+
** This file was automatically generated by the `cloudposse/build-harness`.
2016
** 1) Make all changes to `README.yaml`
2117
** 2) Run `make init` (you only need to do this once)
2218
** 3) Run`make readme` to rebuild this file.
@@ -32,22 +28,17 @@
3228

3329
GitHub Action that outputs list of Atmos components by jq query
3430

35-
---
36-
37-
This project is part of our comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
38-
39-
40-
It's 100% Open Source and licensed under the [APACHE2](LICENSE).
41-
42-
43-
44-
45-
46-
47-
48-
49-
5031

32+
> [!TIP]
33+
> #### 👽 Use Atmos with Terraform
34+
> Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. <br/>
35+
> Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).
36+
>
37+
> <details>
38+
> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary>
39+
> <img src="https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true"/><br/>
40+
> <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>
41+
> </detalis>
5142
5243

5344
## Introduction
@@ -75,9 +66,8 @@ Output of this action is a list of basic component information. For example:
7566

7667

7768

78-
## Usage
79-
8069

70+
## Usage
8171

8272
### Config
8373

@@ -173,6 +163,14 @@ Which would produce the same behavior as in `v2`, doing this:
173163
Please note that the `atmos-gitops-config-path` is not the same file as the `atmos-config-path`.
174164

175165

166+
> [!IMPORTANT]
167+
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
168+
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
169+
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
170+
> approach for updating versions to avoid unexpected changes.
171+
172+
173+
176174

177175

178176

@@ -196,75 +194,94 @@ For additional context, refer to some of these links.
196194
- [example-github-action-release-workflow](https://github.com/cloudposse/example-github-action-release-workflow) - Example application with complicated release workflow
197195

198196

197+
198+
> [!TIP]
199+
> #### Use Terraform Reference Architectures for AWS
200+
>
201+
> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.
202+
>
203+
> ✅ We build it with you.<br/>
204+
> ✅ You own everything.<br/>
205+
> ✅ Your team wins.<br/>
206+
>
207+
> <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>
208+
> <details><summary>📚 <strong>Learn More</strong></summary>
209+
>
210+
> <br/>
211+
>
212+
> 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.
213+
>
214+
> *Your team can operate like a pro today.*
215+
>
216+
> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
217+
> #### Day-0: Your Foundation for Success
218+
> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
219+
> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
220+
> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
221+
> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
222+
> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
223+
>
224+
> <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>
225+
>
226+
> #### Day-2: Your Operational Mastery
227+
> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
228+
> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
229+
> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
230+
> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
231+
> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
232+
> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
233+
> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
234+
>
235+
> <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>
236+
> </details>
237+
199238
## ✨ Contributing
200239

201-
This project is under active development, and we encourage contributions from our community.
240+
This project is under active development, and we encourage contributions from our community.
241+
242+
243+
202244
Many thanks to our outstanding contributors:
203245

204246
<a href="https://github.com/cloudposse/github-action-atmos-terraform-select-components/graphs/contributors">
205247
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-atmos-terraform-select-components&max=24" />
206248
</a>
207249

208-
### 🐛 Bug Reports & Feature Requests
209-
210-
Please use the [issue tracker](https://github.com/cloudposse/github-action-atmos-terraform-select-components/issues) to report any bugs or file feature requests.
211-
212-
### 💻 Developing
213-
214-
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].
250+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/github-action-atmos-terraform-select-components/issues).
215251

216252
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
217-
218-
1. **Fork** the repo on GitHub
219-
2. **Clone** the project to your own machine
220-
3. **Commit** changes to your own branch
221-
4. **Push** your work back up to your fork
222-
5. Submit a **Pull Request** so that we can review your changes
253+
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).
254+
2. **Fork** the repo on GitHub
255+
3. **Clone** the project to your own machine
256+
4. **Commit** changes to your own branch
257+
5. **Push** your work back up to your fork
258+
6. Submit a **Pull Request** so that we can review your changes
223259

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

226262
### 🌎 Slack Community
227263

228-
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.
264+
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&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.
229265

230266
### 📰 Newsletter
231267

232-
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.
233-
234-
### 📆 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" />
235-
236-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
237-
238-
## About
239-
240-
This project is maintained and funded by [Cloud Posse, LLC][website].
241-
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
268+
Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&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.
269+
Dropped straight into your Inbox every week — and usually a 5-minute read.
242270

243-
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.
271+
### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&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>
244272

245-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
246-
247-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
248-
249-
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.
250-
251-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
252-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
253-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
254-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
255-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
256-
- **Training.** You'll receive hands-on training so your team can operate what we build.
257-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
258-
- **Troubleshooting.** You'll get help to triage when things aren't working.
259-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
260-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
261-
262-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
273+
[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.
274+
It's **FREE** for everyone!
263275
## License
264276

265-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
277+
<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>
278+
279+
<details>
280+
<summary>Preamble to the Apache License, Version 2.0</summary>
281+
<br/>
282+
<br/>
266283

267-
See [LICENSE](LICENSE) for full details.
284+
Complete license is available in the [`LICENSE`](LICENSE) file.
268285

269286
```text
270287
Licensed to the Apache Software Foundation (ASF) under one
@@ -284,34 +301,17 @@ KIND, either express or implied. See the License for the
284301
specific language governing permissions and limitations
285302
under the License.
286303
```
304+
</details>
287305

288306
## Trademarks
289307

290308
All other trademarks referenced herein are the property of their respective owners.
309+
310+
291311
---
292-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
293-
[![README Footer][readme_footer_img]][readme_footer_link]
294-
[![Beacon][beacon]][website]
295-
<!-- markdownlint-disable -->
296-
[logo]: https://cloudposse.com/logo-300x69.svg
297-
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=docs
298-
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=website
299-
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=github
300-
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=jobs
301-
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=hire
302-
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=slack
303-
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=twitter
304-
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=office_hours
305-
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=newsletter
306-
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=email
307-
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=commercial_support
308-
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=we_love_open_source
309-
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=terraform_modules
310-
[readme_header_img]: https://cloudposse.com/readme/header/img
311-
[readme_header_link]: 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
312-
[readme_footer_img]: https://cloudposse.com/readme/footer/img
313-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=readme_footer_link
314-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
315-
[readme_commercial_support_link]: 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
316-
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-atmos-terraform-select-components?pixel&cs=github&cm=readme&an=github-action-atmos-terraform-select-components
317-
<!-- markdownlint-restore -->
312+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
313+
314+
315+
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-select-components&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
316+
317+
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-atmos-terraform-select-components?pixel&cs=github&cm=readme&an=github-action-atmos-terraform-select-components"/>

0 commit comments

Comments
 (0)