Skip to content

Commit 050d93a

Browse files
authored
Update README.md and docs
1 parent 49b724b commit 050d93a

File tree

1 file changed

+56
-70
lines changed

1 file changed

+56
-70
lines changed

README.md

Lines changed: 56 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
1-
21
<!-- markdownlint-disable -->
3-
# github-action-atmos-terraform-plan [![Latest Release](https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-plan.svg)](https://github.com/cloudposse/github-action-atmos-terraform-plan/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
2+
# 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>
3+
<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>
44
<!-- markdownlint-restore -->
55

6-
[![README Header][readme_header_img]][readme_header_link]
7-
8-
[![Cloud Posse][logo]](https://cpco.io/homepage)
9-
106
<!--
117
128
139
1410
1511
** DO NOT EDIT THIS FILE
1612
**
17-
** This file was automatically generated by the `build-harness`.
13+
** This file was automatically generated by the `cloudposse/build-harness`.
1814
** 1) Make all changes to `README.yaml`
1915
** 2) Run `make init` (you only need to do this once)
2016
** 3) Run`make readme` to rebuild this file.
@@ -30,22 +26,17 @@
3026

3127
This Github Action is used to run Terraform plan for a single, Atmos-supported component and save the given planfile to S3 and DynamoDB.
3228

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

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>
34+
>
35+
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
36+
>
37+
> </details>
4838
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>
4940

5041

5142
## Introduction
@@ -226,7 +217,7 @@ For additional context, refer to some of these links.
226217

227218
## ✨ Contributing
228219

229-
This project is under active development, and we encourage contributions from our community.
220+
This project is under active development, and we encourage contributions from our community.
230221
Many thanks to our outstanding contributors:
231222

232223
<a href="https://github.com/cloudposse/github-action-atmos-terraform-plan/graphs/contributors">
@@ -239,45 +230,53 @@ Please use the [issue tracker](https://github.com/cloudposse/github-action-atmos
239230

240231
### 💻 Developing
241232

242-
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].
233+
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!
234+
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.
243235

244236
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
245-
246-
1. **Fork** the repo on GitHub
247-
2. **Clone** the project to your own machine
248-
3. **Commit** changes to your own branch
249-
4. **Push** your work back up to your fork
250-
5. Submit a **Pull Request** so that we can review your changes
237+
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).
238+
2. **Fork** the repo on GitHub
239+
3. **Clone** the project to your own machine
240+
4. **Commit** changes to your own branch
241+
5. **Push** your work back up to your fork
242+
6. Submit a **Pull Request** so that we can review your changes
251243

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

254246
### 🌎 Slack Community
255247

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

258250
### 📰 Newsletter
259251

260-
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.
252+
Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&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.
253+
Dropped straight into your Inbox every week — and usually a 5-minute read.
254+
255+
### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&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>
261256

262-
### 📆 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" />
257+
[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.
258+
It's **FREE** for everyone!
263259

264-
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
260+
## About
265261

266-
## About
262+
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>.
263+
<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>
267264

268-
This project is maintained and funded by [Cloud Posse, LLC][website].
269-
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
265+
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.
266+
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
267+
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
270268

271-
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.
269+
<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>
272270

273-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
271+
*Your team can operate like a pro today.*
274272

275-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
273+
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
276274

277-
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.
275+
<details>
276+
<summary>📚 <strong>See What's Included</strong></summary>
278277

279278
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
280-
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
279+
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
281280
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
282281
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
283282
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
@@ -286,13 +285,19 @@ We deliver 10x the value for a fraction of the cost of a full-time engineer. Our
286285
- **Troubleshooting.** You'll get help to triage when things aren't working.
287286
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
288287
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
288+
</details>
289289

290-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
290+
<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>
291291
## License
292292

293-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
293+
<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>
294294

295-
See [LICENSE](LICENSE) for full details.
295+
<details>
296+
<summary>Preamble to the Apache License, Version 2.0</summary>
297+
<br/>
298+
<br/>
299+
300+
Complete license is available in the [`LICENSE`](LICENSE) file.
296301

297302
```text
298303
Licensed to the Apache Software Foundation (ASF) under one
@@ -312,34 +317,15 @@ KIND, either express or implied. See the License for the
312317
specific language governing permissions and limitations
313318
under the License.
314319
```
320+
</details>
315321

316322
## Trademarks
317323

318324
All other trademarks referenced herein are the property of their respective owners.
319325
---
320-
Copyright © 2017-2023 [Cloud Posse, LLC](https://cpco.io/copyright)
321-
[![README Footer][readme_footer_img]][readme_footer_link]
322-
[![Beacon][beacon]][website]
323-
<!-- markdownlint-disable -->
324-
[logo]: https://cloudposse.com/logo-300x69.svg
325-
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=docs
326-
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=website
327-
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=github
328-
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=jobs
329-
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=hire
330-
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=slack
331-
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=twitter
332-
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=office_hours
333-
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=newsletter
334-
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=email
335-
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=commercial_support
336-
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=we_love_open_source
337-
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=terraform_modules
338-
[readme_header_img]: https://cloudposse.com/readme/header/img
339-
[readme_header_link]: 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
340-
[readme_footer_img]: https://cloudposse.com/readme/footer/img
341-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=readme_footer_link
342-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
343-
[readme_commercial_support_link]: 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
344-
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-atmos-terraform-plan?pixel&cs=github&cm=readme&an=github-action-atmos-terraform-plan
345-
<!-- markdownlint-restore -->
326+
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
327+
328+
329+
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-atmos-terraform-plan&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
330+
331+
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/github-action-atmos-terraform-plan?pixel&cs=github&cm=readme&an=github-action-atmos-terraform-plan"/>

0 commit comments

Comments
 (0)