Skip to content

Commit 6543403

Browse files
ostermanosterman
authored
chore: Update Scaffolding (#219)
1 parent d8bc15d commit 6543403

File tree

3 files changed

+89
-174
lines changed

3 files changed

+89
-174
lines changed

‎.github/mergify.yml

Lines changed: 1 addition & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1 @@
1-
# https://docs.mergify.io/conditions.html
2-
# https://docs.mergify.io/actions.html
3-
pull_request_rules:
4-
- name: "approve automated PRs that have passed checks"
5-
conditions:
6-
- "author~=^(cloudpossebot|renovate\\[bot\\])$"
7-
- "-closed"
8-
- "head~=^(auto-update|renovate)/.*"
9-
- "check-success=test/bats"
10-
- "check-success=test/readme"
11-
- "check-success=test/terratest"
12-
- "check-success=validate-codeowners"
13-
- or:
14-
- "base=master"
15-
- "base=main"
16-
- "base~=^release/v\\d{1,2}$"
17-
18-
actions:
19-
review:
20-
type: "APPROVE"
21-
bot_account: "cloudposse-mergebot"
22-
message: "We've automatically approved this PR because the checks from the automated Pull Request have passed."
23-
24-
- name: "merge automated PRs when approved and tests pass"
25-
conditions:
26-
- "author~=^(cloudpossebot|renovate\\[bot\\])$"
27-
- "-closed"
28-
- "head~=^(auto-update|renovate)/.*"
29-
- "check-success=test/bats"
30-
- "check-success=test/readme"
31-
- "check-success=test/terratest"
32-
- "check-success=validate-codeowners"
33-
- "#approved-reviews-by>=1"
34-
- "#changes-requested-reviews-by=0"
35-
- "#commented-reviews-by=0"
36-
- or:
37-
- "base=master"
38-
- "base=main"
39-
- "base~=^release/v\\d{1,2}$"
40-
41-
actions:
42-
merge:
43-
method: "squash"
44-
45-
- name: "delete the head branch after merge"
46-
conditions:
47-
- "merged"
48-
actions:
49-
delete_head_branch: {}
50-
51-
- name: "ask to resolve conflict"
52-
conditions:
53-
- "conflict"
54-
- "-closed"
55-
actions:
56-
comment:
57-
message: "This pull request is now in conflict. Could you fix it @{{author}}? 🙏"
58-
59-
- name: "remove outdated reviews"
60-
conditions:
61-
- or:
62-
- "base=master"
63-
- "base=main"
64-
- "base~=^release/v\\d{1,2}$"
65-
actions:
66-
dismiss_reviews:
67-
changes_requested: true
68-
approved: true
69-
message: "This Pull Request has been updated, so we're dismissing all reviews."
70-
71-
- name: "close Pull Requests without files changed"
72-
conditions:
73-
- "#files=0"
74-
actions:
75-
close:
76-
message: "This pull request has been automatically closed by Mergify because there are no longer any changes."
1+
extends: .github

‎README.md

Lines changed: 67 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
2+
13
<!-- markdownlint-disable -->
24
# terraform-aws-s3-bucket <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
3-
<a href="https://github.com/cloudposse/terraform-aws-s3-bucket/actions"><img src="https://github.com/cloudposse/terraform-aws-s3-bucket/workflows/test/badge.svg?branch=master" alt="GitHub Action Tests"/></a><a href="https://github.com/cloudposse/terraform-aws-s3-bucket/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-s3-bucket.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
5+
<a href="https://github.com/cloudposse/terraform-aws-s3-bucket/actions"><img src="https://github.com/cloudposse/terraform-aws-s3-bucket/workflows/test/badge.svg?branch=master" alt="GitHub Action Tests"/></a><a href="https://github.com/cloudposse/terraform-aws-s3-bucket/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-s3-bucket.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-s3-bucket/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-s3-bucket.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a>
46
<!-- markdownlint-restore -->
57

68
<!--
@@ -61,41 +63,23 @@ but not both. Using SSM Parameter Store is recommended because that will keep th
6163
via Terraform remote state lookup, but the key will still be stored unencrypted in the Terraform state in any case.
6264

6365

64-
---
65-
> [!NOTE]
66-
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content=) approach towards DevOps.
67-
> <details><summary><strong>Learn More</strong></summary>
68-
> <a href="https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content=terraform_modules">
69-
> <picture>
70-
> <source media="(prefers-color-scheme: dark)" srcset="https://docs.cloudposse.com/images/terraform-open-source-modules-light.svg">
71-
> <source media="(prefers-color-scheme: light)" srcset="https://docs.cloudposse.com/images/terraform-open-source-modules-dark.svg">
72-
> <img alt="Terraform Open Source Modules" src="https://docs.cloudposse.com/images/terraform-open-source-modules.svg" align="right">
73-
> </picture>
74-
> </a>
75-
>
66+
> [!TIP]
67+
> #### 👽 Use Atmos with Terraform
68+
> Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. <br/>
69+
> Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).
7670
>
77-
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
78-
>
79-
> We literally have [*hundreds of terraform modules*](https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content=terraform_modules) that are Open Source and well-maintained. Check them out!
80-
> </details>
71+
> <details>
72+
> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary>
73+
> <img src="https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true"/><br/>
74+
> <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>
75+
> </detalis>
8176
82-
<a href="https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content=readme_header_link"><img src="https://cloudposse.com/readme/header/img"/></a>
8377

8478

8579

8680

8781
## Usage
8882

89-
90-
91-
> [!IMPORTANT]
92-
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
93-
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
94-
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
95-
> approach for updating versions to avoid unexpected changes.
96-
97-
98-
9983
Using [BucketOwnerEnforced](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html#object-ownership-overview)
10084

10185
```hcl
@@ -195,6 +179,14 @@ module "s3_bucket" {
195179
}
196180
```
197181

182+
> [!IMPORTANT]
183+
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
184+
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
185+
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
186+
> approach for updating versions to avoid unexpected changes.
187+
188+
189+
198190

199191

200192

@@ -364,23 +356,60 @@ Check out these related projects.
364356
- [terraform-aws-lb-s3-bucket](https://github.com/cloudposse/terraform-aws-lb-s3-bucket) - Terraform module to provision an S3 bucket with built in IAM policy to allow AWS Load Balancers to ship access logs
365357
- [terraform-aws-s3-log-storage](https://github.com/cloudposse/terraform-aws-s3-log-storage) - Terraform module creates an S3 bucket suitable for receiving logs from other AWS services such as S3, CloudFront, and CloudTrail
366358

359+
360+
> [!TIP]
361+
> #### Use Terraform Reference Architectures for AWS
362+
>
363+
> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.
364+
>
365+
> ✅ We build it with you.<br/>
366+
> ✅ You own everything.<br/>
367+
> ✅ Your team wins.<br/>
368+
>
369+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
370+
> <details><summary>📚 <strong>Learn More</strong></summary>
371+
>
372+
> <br/>
373+
>
374+
> Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content=commercial_support) for funded startups and enterprises.
375+
>
376+
> *Your team can operate like a pro today.*
377+
>
378+
> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
379+
> #### Day-0: Your Foundation for Success
380+
> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
381+
> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
382+
> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
383+
> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
384+
> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
385+
>
386+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
387+
>
388+
> #### Day-2: Your Operational Mastery
389+
> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
390+
> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
391+
> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
392+
> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
393+
> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
394+
> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
395+
> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
396+
>
397+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
398+
> </details>
399+
367400
## ✨ Contributing
368401

369402
This project is under active development, and we encourage contributions from our community.
403+
404+
405+
370406
Many thanks to our outstanding contributors:
371407

372408
<a href="https://github.com/cloudposse/terraform-aws-s3-bucket/graphs/contributors">
373409
<img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-s3-bucket&max=24" />
374410
</a>
375411

376-
### 🐛 Bug Reports & Feature Requests
377-
378-
Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-s3-bucket/issues) to report any bugs or file feature requests.
379-
380-
### 💻 Developing
381-
382-
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!
383-
Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content=slack), in the `#cloudposse` channel.
412+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-aws-s3-bucket/issues).
384413

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

406435
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&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.
407436
It's **FREE** for everyone!
408-
409-
## About
410-
411-
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content=">Cloud Posse, LLC</a>.
412-
<a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
413-
414-
We are a [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content=commercial_support) for funded startups and enterprises.
415-
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
416-
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
417-
418-
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
419-
420-
*Your team can operate like a pro today.*
421-
422-
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
423-
424-
<details>
425-
<summary>📚 <strong>See What's Included</strong></summary>
426-
427-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
428-
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
429-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
430-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
431-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
432-
- **Training.** You'll receive hands-on training so your team can operate what we build.
433-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
434-
- **Troubleshooting.** You'll get help to triage when things aren't working.
435-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
436-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
437-
</details>
438-
439-
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-bucket&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
440437
## License
441438

442439
<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>
@@ -471,6 +468,8 @@ under the License.
471468
## Trademarks
472469

473470
All other trademarks referenced herein are the property of their respective owners.
471+
472+
474473
---
475474
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
476475

0 commit comments

Comments
 (0)