Skip to content

Commit 32b7dfd

Browse files
authored
chore: Update Scaffolding (#56)
1 parent aad8f46 commit 32b7dfd

File tree

3 files changed

+80
-157
lines changed

3 files changed

+80
-157
lines changed

Diff for: .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

Diff for: README.md

+67-68
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
2+
13
<!-- markdownlint-disable -->
24
# terraform-aws-dynamodb-autoscaler <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
3-
<a href="https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-dynamodb-autoscaler.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-dynamodb-autoscaler/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-dynamodb-autoscaler.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-dynamodb-autoscaler.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,41 +31,23 @@ Terraform module to provision DynamoDB autoscaler.
2931
Autoscaler scales up/down the provisioned OPS for a DynamoDB table based on the load.
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-dynamodb-autoscaler&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-dynamodb-autoscaler&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-dynamodb-autoscaler&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-dynamodb-autoscaler&utm_content=readme_header_link"><img src="https://cloudposse.com/readme/header/img"/></a>
5145

5246

5347

5448

5549
## Usage
5650

57-
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-
6751
```hcl
6852
module "dynamodb_autoscaler" {
6953
source = "cloudposse/dynamodb-autoscaler/aws"
@@ -86,6 +70,14 @@ module "dynamodb_autoscaler" {
8670
}
8771
```
8872

73+
> [!IMPORTANT]
74+
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
75+
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
76+
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
77+
> approach for updating versions to avoid unexpected changes.
78+
79+
80+
8981

9082

9183

@@ -193,23 +185,60 @@ Check out these related projects.
193185
- [terraform-aws-dynamodb](https://github.com/cloudposse/terraform-aws-dynamodb) - Terraform module that implements AWS DynamoDB with support for AutoScaling
194186
- [terraform-aws-tfstate-backend](https://github.com/cloudposse/terraform-aws-tfstate-backend) - Provision an S3 bucket to store terraform.tfstate file and a DynamoDB table to lock the state file to prevent concurrent modifications and state corruption
195187

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

198231
This project is under active development, and we encourage contributions from our community.
232+
233+
234+
199235
Many thanks to our outstanding contributors:
200236

201237
<a href="https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler/graphs/contributors">
202238
<img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-dynamodb-autoscaler&max=24" />
203239
</a>
204240

205-
### 🐛 Bug Reports & Feature Requests
206-
207-
Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler/issues) to report any bugs or file feature requests.
208-
209-
### 💻 Developing
210-
211-
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!
212-
Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&utm_content=slack), in the `#cloudposse` channel.
241+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler/issues).
213242

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

235264
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&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.
236265
It's **FREE** for everyone!
237-
238-
## About
239-
240-
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&utm_content=">Cloud Posse, LLC</a>.
241-
<a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
242-
243-
We are a [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&utm_content=commercial_support) for funded startups and enterprises.
244-
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
245-
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
246-
247-
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
248-
249-
*Your team can operate like a pro today.*
250-
251-
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
252-
253-
<details>
254-
<summary>📚 <strong>See What's Included</strong></summary>
255-
256-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
257-
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
258-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
259-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
260-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
261-
- **Training.** You'll receive hands-on training so your team can operate what we build.
262-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
263-
- **Troubleshooting.** You'll get help to triage when things aren't working.
264-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
265-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
266-
</details>
267-
268-
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
269266
## License
270267

271268
<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>
@@ -300,6 +297,8 @@ under the License.
300297
## Trademarks
301298

302299
All other trademarks referenced herein are the property of their respective owners.
300+
301+
303302
---
304303
Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
305304

Diff for: README.yaml

+12-13
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,17 @@ license: "APACHE2"
2929
github_repo: cloudposse/terraform-aws-dynamodb-autoscaler
3030
# Badges to display
3131
badges:
32-
- name: "Latest Release"
33-
image: "https://img.shields.io/github/release/cloudposse/terraform-aws-dynamodb-autoscaler.svg"
34-
url: "https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler/releases/latest"
35-
- name: "Slack Community"
36-
image: "https://slack.cloudposse.com/badge.svg"
37-
url: "https://slack.cloudposse.com"
32+
- name: Latest Release
33+
image: https://img.shields.io/github/release/cloudposse/terraform-aws-dynamodb-autoscaler.svg?style=for-the-badge
34+
url: https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler/releases/latest
35+
- name: Last Updated
36+
image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-dynamodb-autoscaler.svg?style=for-the-badge
37+
url: https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler/commits
38+
- name: Slack Community
39+
image: https://slack.cloudposse.com/for-the-badge.svg
40+
url: https://slack.cloudposse.com
41+
42+
# List any related terraform modules that this module may be used with or that this module depends on.
3843
related:
3944
- name: "terraform-aws-dynamodb"
4045
description: "Terraform module that implements AWS DynamoDB with support for AutoScaling"
@@ -74,10 +79,4 @@ include:
7479
- "docs/targets.md"
7580
- "docs/terraform.md"
7681
# Contributors to this project
77-
contributors:
78-
- name: "Erik Osterman"
79-
github: "osterman"
80-
- name: "Andriy Knysh"
81-
github: "aknysh"
82-
- name: "Michele Cantelli"
83-
github: "emmekappa"
82+
contributors: []

0 commit comments

Comments
 (0)