Skip to content

Commit 0ae38d5

Browse files
authored
chore: Update Scaffolding (#47)
1 parent 8e21b0f commit 0ae38d5

File tree

3 files changed

+104
-162
lines changed

3 files changed

+104
-162
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: 62 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
2+
13
<!-- markdownlint-disable -->
24
# terraform-example-module <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-example-module&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
3-
5+
<a href="https://github.com/cloudposse/terraform-example-module/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-example-module.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-example-module/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-example-module.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,25 +31,17 @@ Terraform module for AWS resources. It's a template repository you can
2931
use when creating new repositories. This is not a useful module by itself.
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-example-module&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-example-module&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-
>
44-
>
45-
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
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).
4638
>
47-
> We literally have [*hundreds of terraform modules*](https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-example-module&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-example-module&utm_content=readme_header_link"><img src="https://cloudposse.com/readme/header/img"/></a>
5145

5246

5347

@@ -69,7 +63,6 @@ use when creating new repositories. This is not a useful module by itself.
6963

7064

7165

72-
7366
## Related Projects
7467

7568
Check out these related projects.
@@ -87,17 +80,60 @@ For additional context, refer to some of these links.
8780
- [Terraform Version Pinning](https://www.terraform.io/docs/language/settings/index.html#specifying-a-required-terraform-version) - The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration
8881

8982

83+
84+
> [!TIP]
85+
> #### Use Terraform Reference Architectures for AWS
86+
>
87+
> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.
88+
>
89+
> ✅ We build it with you.<br/>
90+
> ✅ You own everything.<br/>
91+
> ✅ Your team wins.<br/>
92+
>
93+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-example-module&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
94+
> <details><summary>📚 <strong>Learn More</strong></summary>
95+
>
96+
> <br/>
97+
>
98+
> Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-example-module&utm_content=commercial_support) for funded startups and enterprises.
99+
>
100+
> *Your team can operate like a pro today.*
101+
>
102+
> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
103+
> #### Day-0: Your Foundation for Success
104+
> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
105+
> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
106+
> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
107+
> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
108+
> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
109+
>
110+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-example-module&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
111+
>
112+
> #### Day-2: Your Operational Mastery
113+
> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
114+
> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
115+
> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
116+
> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
117+
> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
118+
> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
119+
> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
120+
>
121+
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-example-module&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
122+
> </details>
123+
90124
## ✨ Contributing
91125

126+
This project is under active development, and we encourage contributions from our community.
127+
92128

93-
### 🐛 Bug Reports & Feature Requests
94129

95-
Please use the [issue tracker](https://github.com/cloudposse/terraform-example-module/issues) to report any bugs or file feature requests.
130+
Many thanks to our outstanding contributors:
96131

97-
### 💻 Developing
132+
<a href="https://github.com/cloudposse/terraform-example-module/graphs/contributors">
133+
<img src="https://contrib.rocks/image?repo=cloudposse/terraform-example-module&max=24" />
134+
</a>
98135

99-
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!
100-
Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-example-module&utm_content=slack), in the `#cloudposse` channel.
136+
For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-example-module/issues).
101137

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

123159
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-example-module&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.
124160
It's **FREE** for everyone!
125-
126-
## About
127-
128-
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-example-module&utm_content=">Cloud Posse, LLC</a>.
129-
<a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-example-module&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
130-
131-
We are a [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-example-module&utm_content=commercial_support) for funded startups and enterprises.
132-
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
133-
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
134-
135-
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-example-module&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
136-
137-
*Your team can operate like a pro today.*
138-
139-
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
140-
141-
<details>
142-
<summary>📚 <strong>See What's Included</strong></summary>
143-
144-
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
145-
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
146-
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
147-
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
148-
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
149-
- **Training.** You'll receive hands-on training so your team can operate what we build.
150-
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
151-
- **Troubleshooting.** You'll get help to triage when things aren't working.
152-
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
153-
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
154-
</details>
155-
156-
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-example-module&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
157161
## License
158162

159163
<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>
@@ -188,6 +192,8 @@ under the License.
188192
## Trademarks
189193

190194
All other trademarks referenced herein are the property of their respective owners.
195+
196+
191197
## Copyrights
192198

193199
Copyright © 2021-2024 [Cloud Posse, LLC](https://cloudposse.com)

README.yaml

Lines changed: 41 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ license: "APACHE2"
1515

1616
# Copyrights
1717
copyrights:
18-
- name: "Cloud Posse, LLC"
19-
url: "https://cloudposse.com"
20-
year: "2021"
18+
- name: "Cloud Posse, LLC"
19+
url: "https://cloudposse.com"
20+
year: "2021"
2121

2222
# Canonical GitHub repo
2323
github_repo: cloudposse/terraform-example-module
@@ -40,25 +40,38 @@ quickstart: |-
4040
8. Commit everything to `git` and open your first PR on the new repo.
4141
4242
references:
43-
- name: "Cloud Posse Documentation"
44-
url: "https://docs.cloudposse.com"
45-
description: "The Cloud Posse Developer Hub (documentation)"
46-
- name: "Terraform Standard Module Structure"
47-
description: "HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories."
48-
url: "https://www.terraform.io/docs/language/modules/develop/structure.html"
49-
- name: "Terraform Module Requirements"
50-
description: "HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy."
51-
url: "https://www.terraform.io/docs/registry/modules/publish.html#requirements"
52-
- name: "Terraform Version Pinning"
53-
description: "The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration"
54-
url: "https://www.terraform.io/docs/language/settings/index.html#specifying-a-required-terraform-version"
43+
- name: "Cloud Posse Documentation"
44+
url: "https://docs.cloudposse.com"
45+
description: "The Cloud Posse Developer Hub (documentation)"
46+
- name: "Terraform Standard Module Structure"
47+
description: "HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories."
48+
url: "https://www.terraform.io/docs/language/modules/develop/structure.html"
49+
- name: "Terraform Module Requirements"
50+
description: "HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy."
51+
url: "https://www.terraform.io/docs/registry/modules/publish.html#requirements"
52+
- name: "Terraform Version Pinning"
53+
description: "The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration"
54+
url: "https://www.terraform.io/docs/language/settings/index.html#specifying-a-required-terraform-version"
5555

56+
57+
# List any related terraform modules that this module may be used with or that this module depends on.
5658
related:
57-
- name: "Example App"
58-
url: "https://github.com/cloudposse/example-app"
59-
description: "Example application for CI/CD demonstrations of Codefresh"
59+
- name: "Example App"
60+
url: "https://github.com/cloudposse/example-app"
61+
description: "Example application for CI/CD demonstrations of Codefresh"
6062

6163

64+
badges:
65+
- name: Latest Release
66+
image: https://img.shields.io/github/release/cloudposse/terraform-example-module.svg?style=for-the-badge
67+
url: https://github.com/cloudposse/terraform-example-module/releases/latest
68+
- name: Last Updated
69+
image: https://img.shields.io/github/last-commit/cloudposse/terraform-example-module.svg?style=for-the-badge
70+
url: https://github.com/cloudposse/terraform-example-module/commits
71+
- name: Slack Community
72+
image: https://slack.cloudposse.com/for-the-badge.svg
73+
url: https://slack.cloudposse.com
74+
contributors: []
6275
---
6376
# DELETE ME
6477
#
@@ -94,15 +107,15 @@ github_repo:
94107

95108
# Badges to display
96109
badges:
97-
- name: "Latest Release"
98-
image: "https://img.shields.io/github/release/cloudposse/terraform-example-module.svg"
99-
url: "https://github.com/cloudposse/terraform-example-module/releases/latest"
100-
- name: "Slack Community"
101-
image: "https://slack.cloudposse.com/badge.svg"
102-
url: "https://slack.cloudposse.com"
103-
- name: "Discourse Forum"
104-
image: "https://img.shields.io/discourse/https/ask.sweetops.com/posts.svg"
105-
url: "https://ask.sweetops.com/"
110+
- name: Latest Release
111+
image: https://img.shields.io/github/release/None.svg?style=for-the-badge
112+
url: https://github.com/None/releases/latest
113+
- name: Last Updated
114+
image: https://img.shields.io/github/last-commit/None.svg?style=for-the-badge
115+
url: https://github.com/None/commits
116+
- name: Slack Community
117+
image: https://slack.cloudposse.com/for-the-badge.svg
118+
url: https://slack.cloudposse.com
106119

107120
# List any related terraform modules that this module may be used with or that this module depends on.
108121
related:
@@ -166,6 +179,4 @@ include:
166179
- "docs/terraform.md"
167180

168181
# Contributors to this project
169-
contributors:
170-
- name: "Erik Osterman"
171-
github: "osterman"
182+
contributors: []

0 commit comments

Comments
 (0)