Skip to content

Commit c47e440

Browse files
authored
Update README.md and docs
1 parent d197ad2 commit c47e440

File tree

2 files changed

+68
-52
lines changed

2 files changed

+68
-52
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-drift-detection <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&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-drift-detection/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-drift-detection.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 detect drift
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-drift-detection&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-drift-detection&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
@@ -51,9 +53,8 @@ There is another companion action [github-action-atmos-terraform-drift-remediati
5153

5254

5355

54-
## Usage
55-
5656

57+
## Usage
5758

5859
### Workflow example
5960

@@ -120,6 +121,14 @@ There is another companion action [github-action-atmos-terraform-drift-remediati
120121
max-opened-issues: '3'
121122
```
122123
124+
> [!IMPORTANT]
125+
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
126+
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
127+
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
128+
> approach for updating versions to avoid unexpected changes.
129+
130+
131+
123132
124133
125134
@@ -159,23 +168,60 @@ For additional context, refer to some of these links.
159168
- [github-action-terraform-plan-storage](https://github.com/cloudposse/github-action-terraform-plan-storage) - A GitHub Action to securely store Terraform plan files in an S3 bucket with metadata storage in DynamoDB.
160169

161170

171+
172+
> [!TIP]
173+
> #### Use Terraform Reference Architectures for AWS
174+
>
175+
> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.
176+
>
177+
> ✅ We build it with you.<br/>
178+
> ✅ You own everything.<br/>
179+
> ✅ Your team wins.<br/>
180+
>
181+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
182+
> <details><summary>📚 <strong>Learn More</strong></summary>
183+
>
184+
> <br/>
185+
>
186+
> 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-drift-detection&utm_content=commercial_support) for funded startups and enterprises.
187+
>
188+
> *Your team can operate like a pro today.*
189+
>
190+
> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
191+
> #### Day-0: Your Foundation for Success
192+
> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
193+
> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
194+
> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
195+
> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
196+
> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
197+
>
198+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
199+
>
200+
> #### Day-2: Your Operational Mastery
201+
> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
202+
> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
203+
> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
204+
> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
205+
> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
206+
> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
207+
> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
208+
>
209+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
210+
> </details>
211+
162212
## ✨ Contributing
163213

164214
This project is under active development, and we encourage contributions from our community.
215+
216+
217+
165218
Many thanks to our outstanding contributors:
166219

167220
<a href="https://github.com/cloudposse/github-action-atmos-terraform-drift-detection/graphs/contributors">
168221
<img src="https://contrib.rocks/image?repo=cloudposse/github-action-atmos-terraform-drift-detection&max=24" />
169222
</a>
170223

171-
### 🐛 Bug Reports & Feature Requests
172-
173-
Please use the [issue tracker](https://github.com/cloudposse/github-action-atmos-terraform-drift-detection/issues) to report any bugs or file feature requests.
174-
175-
### 💻 Developing
176-
177-
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!
178-
Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=slack), in the `#cloudposse` channel.
224+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/github-action-atmos-terraform-drift-detection/issues).
179225

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

201247
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&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.
202248
It's **FREE** for everyone!
203-
204-
## About
205-
206-
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=">Cloud Posse, LLC</a>.
207-
<a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
208-
209-
We are a [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=commercial_support) for funded startups and enterprises.
210-
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
211-
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
212-
213-
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
214-
215-
*Your team can operate like a pro today.*
216-
217-
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
218-
219-
<details>
220-
<summary>📚 <strong>See What's Included</strong></summary>
221-
222-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
223-
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
224-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
225-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
226-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
227-
- **Training.** You'll receive hands-on training so your team can operate what we build.
228-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
229-
- **Troubleshooting.** You'll get help to triage when things aren't working.
230-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
231-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
232-
</details>
233-
234-
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-drift-detection&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
235249
## License
236250

237251
<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>
@@ -266,6 +280,8 @@ under the License.
266280
## Trademarks
267281

268282
All other trademarks referenced herein are the property of their respective owners.
283+
284+
269285
---
270286
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
271287

build-harness

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Subproject commit 784c6b3f8fb61935bc88787079aa964885b2d9ea
1+
Subproject commit 8736431500f46a3496a149914f4d4b0160e218a6

0 commit comments

Comments
 (0)