You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
** This file was automatically generated by the `build-harness`.
15
+
** This file was automatically generated by the `cloudposse/build-harness`.
18
16
** 1) Make all changes to `README.yaml`
19
17
** 2) Run `make init` (you only need to do this once)
20
18
** 3) Run`make readme` to rebuild this file.
@@ -30,22 +28,17 @@
30
28
31
29
This Github Action is used to run Terraform plan for a single, Atmos-supported component and save the given planfile to S3 and DynamoDB.
32
30
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
-
47
-
48
31
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>
> <i>Example of running <ahref="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <ahref="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i>
41
+
> </detalis>
49
42
50
43
51
44
## Introduction
@@ -56,9 +49,8 @@ After running this action, apply Terraform with the companion action, [github-ac
56
49
57
50
58
51
59
-
## Usage
60
-
61
52
53
+
## Usage
62
54
63
55
### Prerequisites
64
56
@@ -178,6 +170,14 @@ Which would produce the same behavior as in `v1`, doing this:
178
170
aws-region: "us-east-2"
179
171
```
180
172
173
+
> [!IMPORTANT]
174
+
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
175
+
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
176
+
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
177
+
> approach for updating versions to avoid unexpected changes.
178
+
179
+
180
+
181
181
182
182
183
183
@@ -224,75 +224,94 @@ For additional context, refer to some of these links.
224
224
- [github-action-terraform-plan-storage](https://github.com/cloudposse/github-action-terraform-plan-storage) - GitHub Action to store Terraform plans
225
225
226
226
227
+
228
+
> [!TIP]
229
+
> #### Use Terraform Reference Architectures for AWS
230
+
>
231
+
> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.
> 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.
243
+
>
244
+
> *Your team can operate like a pro today.*
245
+
>
246
+
> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
247
+
> #### Day-0: Your Foundation for Success
248
+
> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
249
+
> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
250
+
> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
251
+
> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
252
+
> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
258
+
> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
259
+
> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
260
+
> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
261
+
> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
262
+
> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
263
+
> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
Please use the [issue tracker](https://github.com/cloudposse/github-action-atmos-terraform-plan/issues) to report any bugs or file feature requests.
239
-
240
-
### 💻 Developing
241
-
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].
280
+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/github-action-atmos-terraform-plan/issues).
243
281
244
282
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
283
+
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).
284
+
2. **Fork** the repo on GitHub
285
+
3. **Clone** the project to your own machine
286
+
4. **Commit** changes to your own branch
287
+
5. **Push** your work back up to your fork
288
+
6. Submit a **Pull Request** so that we can review your changes
251
289
252
290
**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
253
291
254
292
### 🌎 Slack Community
255
293
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.
294
+
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.
257
295
258
296
### 📰 Newsletter
259
297
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.
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.
299
+
Dropped straight into your Inbox every week — and usually a 5-minute read.
270
300
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.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
276
-
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.
278
-
279
-
- **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.
281
-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
282
-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
283
-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
284
-
- **Training.** You'll receive hands-on training so your team can operate what we build.
285
-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
286
-
- **Troubleshooting.** You'll get help to triage when things aren't working.
287
-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
288
-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
[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.
0 commit comments