Skip to content

Commit 00432b1

Browse files
authored
Update README.md and docs
1 parent c4987d2 commit 00432b1

File tree

1 file changed

+67
-51
lines changed

1 file changed

+67
-51
lines changed

README.md

Lines changed: 67 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
2+
13
<!-- markdownlint-disable -->
24
# github-action-atmos-terraform-plan <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
35
<a href="https://github.com/cloudposse/github-action-atmos-terraform-plan/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-plan.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
@@ -27,16 +29,16 @@
2729
This Github Action is used to run Terraform plan for a single, Atmos-supported component and save the given planfile to S3 and DynamoDB.
2830

2931

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-plan&utm_content=) approach towards DevOps.
33-
> <details><summary><strong>Learn More</strong></summary>
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).
3436
>
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-plan&utm_content=readme_header_link"><img src="https://cloudposse.com/readme/header/img"/></a>
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>
4042
4143

4244
## Introduction
@@ -47,9 +49,8 @@ After running this action, apply Terraform with the companion action, [github-ac
4749

4850

4951

50-
## Usage
51-
5252

53+
## Usage
5354

5455
### Prerequisites
5556

@@ -265,6 +266,14 @@ Which would produce the same behavior as in `v1`, doing this:
265266
aws-region: "us-east-2"
266267
```
267268

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+
268277

269278

270279

@@ -312,23 +321,60 @@ For additional context, refer to some of these links.
312321
- [github-action-terraform-plan-storage](https://github.com/cloudposse/github-action-terraform-plan-storage) - GitHub Action to store Terraform plans
313322

314323

324+
325+
> [!TIP]
326+
> #### Use Terraform Reference Architectures for AWS
327+
>
328+
> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.
329+
>
330+
> ✅ We build it with you.<br/>
331+
> ✅ You own everything.<br/>
332+
> ✅ Your team wins.<br/>
333+
>
334+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
335+
> <details><summary>📚 <strong>Learn More</strong></summary>
336+
>
337+
> <br/>
338+
>
339+
> 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-plan&utm_content=commercial_support) for funded startups and enterprises.
340+
>
341+
> *Your team can operate like a pro today.*
342+
>
343+
> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
344+
> #### Day-0: Your Foundation for Success
345+
> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
346+
> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
347+
> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
348+
> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
349+
> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
350+
>
351+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
352+
>
353+
> #### Day-2: Your Operational Mastery
354+
> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
355+
> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
356+
> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
357+
> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
358+
> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
359+
> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
360+
> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
361+
>
362+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
363+
> </details>
364+
315365
## ✨ Contributing
316366

317367
This project is under active development, and we encourage contributions from our community.
368+
369+
370+
318371
Many thanks to our outstanding contributors:
319372

320373
<a href="https://github.com/cloudposse/github-action-atmos-terraform-plan/graphs/contributors">
321374
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-atmos-terraform-plan&max=24" />
322375
</a>
323376

324-
### 🐛 Bug Reports & Feature Requests
325-
326-
Please use the [issue tracker](https://github.com/cloudposse/github-action-atmos-terraform-plan/issues) to report any bugs or file feature requests.
327-
328-
### 💻 Developing
329-
330-
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!
331-
Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=slack), in the `#cloudposse` channel.
377+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/github-action-atmos-terraform-plan/issues).
332378

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

354400
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&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.
355401
It's **FREE** for everyone!
356-
357-
## About
358-
359-
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=">Cloud Posse, LLC</a>.
360-
<a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
361-
362-
We are a [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=commercial_support) for funded startups and enterprises.
363-
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
364-
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
365-
366-
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
367-
368-
*Your team can operate like a pro today.*
369-
370-
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
371-
372-
<details>
373-
<summary>📚 <strong>See What's Included</strong></summary>
374-
375-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
376-
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
377-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
378-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
379-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
380-
- **Training.** You'll receive hands-on training so your team can operate what we build.
381-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
382-
- **Troubleshooting.** You'll get help to triage when things aren't working.
383-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
384-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
385-
</details>
386-
387-
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
388402
## License
389403

390404
<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>
@@ -419,6 +433,8 @@ under the License.
419433
## Trademarks
420434

421435
All other trademarks referenced herein are the property of their respective owners.
436+
437+
422438
---
423439
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
424440

0 commit comments

Comments
 (0)