Skip to content

Commit fea95c8

Browse files
authored
chore: Update Scaffolding (#196)
1 parent c07a638 commit fea95c8

File tree

3 files changed

+76
-167
lines changed

3 files changed

+76
-167
lines changed

.github/mergify.yml

+1-76
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

+67-68
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
2+
13
<!-- markdownlint-disable -->
24
# terraform-aws-rds-cluster <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
3-
<a href="https://github.com/cloudposse/terraform-aws-rds-cluster/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-rds-cluster.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-rds-cluster/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-rds-cluster.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-rds-cluster/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-rds-cluster.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
<!--
@@ -29,42 +31,24 @@ Terraform module to provision an [`RDS Aurora`](https://aws.amazon.com/rds/auror
2931
Supports [Amazon Aurora Serverless](https://aws.amazon.com/rds/aurora/serverless/).
3032

3133

32-
---
33-
> [!NOTE]
34-
> 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-rds-cluster&utm_content=) approach towards DevOps.
35-
> <details><summary><strong>Learn More</strong></summary>
36-
> <a href="https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=terraform_modules">
37-
> <picture>
38-
> <source media="(prefers-color-scheme: dark)" srcset="https://docs.cloudposse.com/images/terraform-open-source-modules-light.svg">
39-
> <source media="(prefers-color-scheme: light)" srcset="https://docs.cloudposse.com/images/terraform-open-source-modules-dark.svg">
40-
> <img alt="Terraform Open Source Modules" src="https://docs.cloudposse.com/images/terraform-open-source-modules.svg" align="right">
41-
> </picture>
42-
> </a>
43-
>
34+
> [!TIP]
35+
> #### 👽 Use Atmos with Terraform
36+
> Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. <br/>
37+
> Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).
4438
>
45-
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
46-
>
47-
> We literally have [*hundreds of terraform modules*](https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=terraform_modules) that are Open Source and well-maintained. Check them out!
48-
> </details>
39+
> <details>
40+
> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary>
41+
> <img src="https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true"/><br/>
42+
> <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>
43+
> </detalis>
4944
50-
<a href="https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=readme_header_link"><img src="https://cloudposse.com/readme/header/img"/></a>
5145

5246

5347

5448

5549
## Usage
5650

5751

58-
59-
> [!IMPORTANT]
60-
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
61-
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
62-
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
63-
> approach for updating versions to avoid unexpected changes.
64-
65-
66-
67-
6852
For a complete example, see [examples/complete](examples/complete).
6953

7054
For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) (which tests and deploys the example on AWS), see [test](test).
@@ -298,6 +282,13 @@ module "rds_cluster_aurora_postgres" {
298282
}
299283
```
300284

285+
> [!IMPORTANT]
286+
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
287+
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
288+
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
289+
> approach for updating versions to avoid unexpected changes.
290+
291+
301292

302293

303294

@@ -307,6 +298,7 @@ Review the [complete example](examples/complete) to see how to use this module.
307298

308299

309300

301+
310302
<!-- markdownlint-disable -->
311303
## Makefile Targets
312304
```text
@@ -495,23 +487,60 @@ Check out these related projects.
495487
- [terraform-aws-rds](https://github.com/cloudposse/terraform-aws-rds) - Terraform module to provision AWS RDS instances
496488
- [terraform-aws-rds-cloudwatch-sns-alarms](https://github.com/cloudposse/terraform-aws-rds-cloudwatch-sns-alarms) - Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic
497489

490+
491+
> [!TIP]
492+
> #### Use Terraform Reference Architectures for AWS
493+
>
494+
> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.
495+
>
496+
> ✅ We build it with you.<br/>
497+
> ✅ You own everything.<br/>
498+
> ✅ Your team wins.<br/>
499+
>
500+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
501+
> <details><summary>📚 <strong>Learn More</strong></summary>
502+
>
503+
> <br/>
504+
>
505+
> Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=commercial_support) for funded startups and enterprises.
506+
>
507+
> *Your team can operate like a pro today.*
508+
>
509+
> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
510+
> #### Day-0: Your Foundation for Success
511+
> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
512+
> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
513+
> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
514+
> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
515+
> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
516+
>
517+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
518+
>
519+
> #### Day-2: Your Operational Mastery
520+
> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
521+
> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
522+
> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
523+
> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
524+
> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
525+
> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
526+
> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
527+
>
528+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
529+
> </details>
530+
498531
## ✨ Contributing
499532

500533
This project is under active development, and we encourage contributions from our community.
534+
535+
536+
501537
Many thanks to our outstanding contributors:
502538

503539
<a href="https://github.com/cloudposse/terraform-aws-rds-cluster/graphs/contributors">
504540
<img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-rds-cluster&max=24" />
505541
</a>
506542

507-
### 🐛 Bug Reports & Feature Requests
508-
509-
Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-rds-cluster/issues) to report any bugs or file feature requests.
510-
511-
### 💻 Developing
512-
513-
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!
514-
Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=slack), in the `#cloudposse` channel.
543+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-aws-rds-cluster/issues).
515544

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

537566
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&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.
538567
It's **FREE** for everyone!
539-
540-
## About
541-
542-
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=">Cloud Posse, LLC</a>.
543-
<a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
544-
545-
We are a [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=commercial_support) for funded startups and enterprises.
546-
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
547-
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
548-
549-
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
550-
551-
*Your team can operate like a pro today.*
552-
553-
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
554-
555-
<details>
556-
<summary>📚 <strong>See What's Included</strong></summary>
557-
558-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
559-
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
560-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
561-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
562-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
563-
- **Training.** You'll receive hands-on training so your team can operate what we build.
564-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
565-
- **Troubleshooting.** You'll get help to triage when things aren't working.
566-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
567-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
568-
</details>
569-
570-
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-rds-cluster&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
571568
## License
572569

573570
<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>
@@ -602,6 +599,8 @@ under the License.
602599
## Trademarks
603600

604601
All other trademarks referenced herein are the property of their respective owners.
602+
603+
605604
---
606605
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
607606

README.yaml

+8-23
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,22 @@ github_repo: cloudposse/terraform-aws-rds-cluster
2020

2121
badges:
2222
- name: Latest Release
23-
image: https://img.shields.io/github/release/cloudposse/terraform-aws-rds-cluster.svg
23+
image: https://img.shields.io/github/release/cloudposse/terraform-aws-rds-cluster.svg?style=for-the-badge
2424
url: https://github.com/cloudposse/terraform-aws-rds-cluster/releases/latest
25+
- name: Last Updated
26+
image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-rds-cluster.svg?style=for-the-badge
27+
url: https://github.com/cloudposse/terraform-aws-rds-cluster/commits
2528
- name: Slack Community
26-
image: https://slack.cloudposse.com/badge.svg
29+
image: https://slack.cloudposse.com/for-the-badge.svg
2730
url: https://slack.cloudposse.com
2831

32+
# List any related terraform modules that this module may be used with or that this module depends on.
2933
related:
3034
- name: terraform-aws-rds
3135
description: Terraform module to provision AWS RDS instances
3236
url: https://github.com/cloudposse/terraform-aws-rds
3337
- name: terraform-aws-rds-cloudwatch-sns-alarms
34-
description: Terraform module that configures important RDS alerts using CloudWatch
35-
and sends them to an SNS topic
38+
description: Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic
3639
url: https://github.com/cloudposse/terraform-aws-rds-cloudwatch-sns-alarms
3740

3841
description: |-
@@ -282,22 +285,4 @@ include:
282285
- docs/targets.md
283286
- docs/terraform.md
284287

285-
contributors:
286-
- name: Erik Osterman
287-
github: osterman
288-
- name: Igor Rodionov
289-
github: goruha
290-
- name: Andriy Knysh
291-
github: aknysh
292-
- name: Sarkis Varozian
293-
github: sarkis
294-
- name: Mike Crowe
295-
github: mike-zipit
296-
- name: Sergey Vasilyev
297-
github: s2504s
298-
- name: Todor Todorov
299-
github: tptodorov
300-
- name: Lee Huffman
301-
github: leehuffman
302-
- name: RB
303-
github: nitrocode
288+
contributors: []

0 commit comments

Comments
 (0)