chore: Update Scaffolding (#100)

cloudposse · Mar 9, 2024 · e3835d5 · e3835d5
1 parent 6bd8692
commit e3835d5
Show file tree

Hide file tree

Showing 3 changed files with 96 additions and 146 deletions.
diff --git a/.github/mergify.yml b/.github/mergify.yml
@@ -1,76 +1 @@
-# https://docs.mergify.io/conditions.html
-# https://docs.mergify.io/actions.html
-pull_request_rules:
-- name: "approve automated PRs that have passed checks"
-  conditions:
-  - "author~=^(cloudpossebot|renovate\\[bot\\])$"
-  - "-closed"
-  - "head~=^(auto-update|renovate)/.*"
-  - "check-success=test/bats"
-  - "check-success=test/readme"
-  - "check-success=test/terratest"
-  - "check-success=validate-codeowners"
-  - or:
-    - "base=master"
-    - "base=main"
-    - "base~=^release/v\\d{1,2}$"
-
-  actions:
-    review:
-      type: "APPROVE"
-      bot_account: "cloudposse-mergebot"
-      message: "We've automatically approved this PR because the checks from the automated Pull Request have passed."
-
-- name: "merge automated PRs when approved and tests pass"
-  conditions:
-  - "author~=^(cloudpossebot|renovate\\[bot\\])$"
-  - "-closed"
-  - "head~=^(auto-update|renovate)/.*"
-  - "check-success=test/bats"
-  - "check-success=test/readme"
-  - "check-success=test/terratest"
-  - "check-success=validate-codeowners"
-  - "#approved-reviews-by>=1"
-  - "#changes-requested-reviews-by=0"
-  - "#commented-reviews-by=0"
-  - or:
-    - "base=master"
-    - "base=main"
-    - "base~=^release/v\\d{1,2}$"
-
-  actions:
-    merge:
-      method: "squash"
-
-- name: "delete the head branch after merge"
-  conditions:
-  - "merged"
-  actions:
-    delete_head_branch: {}
-
-- name: "ask to resolve conflict"
-  conditions:
-  - "conflict"
-  - "-closed"
-  actions:
-    comment:
-      message: "This pull request is now in conflict. Could you fix it @{{author}}? 🙏"
-
-- name: "remove outdated reviews"
-  conditions:
-  - or:
-    - "base=master"
-    - "base=main"
-    - "base~=^release/v\\d{1,2}$"
-  actions:
-    dismiss_reviews:
-      changes_requested: true
-      approved: true
-      message: "This Pull Request has been updated, so we're dismissing all reviews."
-
-- name: "close Pull Requests without files changed"
-  conditions:
-    - "#files=0"
-  actions:
-    close:
-      message: "This pull request has been automatically closed by Mergify because there are no longer any changes."
+extends: .github
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 <!-- markdownlint-disable -->
 # terraform-aws-s3-log-storage <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-log-storage&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
-<a href="https://github.com/cloudposse/terraform-aws-s3-log-storage/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-s3-log-storage.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
+<a href="https://github.com/cloudposse/terraform-aws-s3-log-storage/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-s3-log-storage.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-s3-log-storage/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-s3-log-storage.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>
 <!-- markdownlint-restore -->
 
 <!--
@@ -47,7 +47,6 @@ a truly breaking change. However, be mindful that the behavior of inputs set to
 may change in the future, so we recommend setting them to the desired value explicitly.
 
 
-
 > [!TIP]
 > #### 👽 Use Atmos with Terraform
 > Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. <br/>
@@ -63,8 +62,6 @@ may change in the future, so we recommend setting them to the desired value expl
 
 
 
-
-
 ## Usage
 
 
@@ -130,7 +127,6 @@ module "log_storage" {
 
 
 
-
 <!-- markdownlint-disable -->
 ## Makefile Targets
 ```text
@@ -258,23 +254,60 @@ Check out these related projects.
 - [terraform-aws-s3-logs-athena-query](https://github.com/cloudposse/terraform-aws-s3-logs-athena-query) - A Terraform module that creates an Athena Database and Structure for querying S3 access logs
 - [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
 
+
+> [!TIP]
+> #### Use Terraform Reference Architectures for AWS
+>
+> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.
+>
+> ✅ We build it with you.<br/>
+> ✅ You own everything.<br/>
+> ✅ Your team wins.<br/>
+>
+> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-log-storage&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
+> <details><summary>📚 <strong>Learn More</strong></summary>
+>
+> <br/>
+>
+> Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-log-storage&utm_content=commercial_support) for funded startups and enterprises.
+>
+> *Your team can operate like a pro today.*
+>
+> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
+> #### Day-0:  Your Foundation for Success
+> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
+> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
+> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
+> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
+> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
+>
+> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-log-storage&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
+>
+> #### Day-2: Your Operational Mastery
+> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
+> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
+> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
+> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
+> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
+> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
+> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
+>
+> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-log-storage&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
+> </details>
+
 ## ✨ Contributing
 
 This project is under active development, and we encourage contributions from our community.
+
+
+
 Many thanks to our outstanding contributors:
 
 <a href="https://github.com/cloudposse/terraform-aws-s3-log-storage/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-s3-log-storage&max=24" />
 </a>
 
-### 🐛 Bug Reports & Feature Requests
-
-Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-s3-log-storage/issues) to report any bugs or file feature requests.
-
-### 💻 Developing
-
-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!
-Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-s3-log-storage&utm_content=slack), in the `#cloudposse` channel.
+For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-aws-s3-log-storage/issues).
 
 In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
  1. Review our [Code of Conduct](https://github.com/cloudposse/terraform-aws-s3-log-storage/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).

diff --git a/README.yaml b/README.yaml
@@ -1,50 +1,52 @@
 name: terraform-aws-s3-log-storage
 tags:
-- aws
-- terraform
-- terraform-modules
-- logging
-- s3
-- bucket
-- logs
-- storage
-- glacier
-- standard
-- lifecycle-management
-- versioning
+  - aws
+  - terraform
+  - terraform-modules
+  - logging
+  - s3
+  - bucket
+  - logs
+  - storage
+  - glacier
+  - standard
+  - lifecycle-management
+  - versioning
 categories:
-- terraform-modules/logging
+  - terraform-modules/logging
 license: APACHE2
 github_repo: cloudposse/terraform-aws-s3-log-storage
 badges:
-- name: Latest Release
-  image: https://img.shields.io/github/release/cloudposse/terraform-aws-s3-log-storage.svg
-  url: https://github.com/cloudposse/terraform-aws-s3-log-storage/releases/latest
-- name: Slack Community
-  image: https://slack.cloudposse.com/badge.svg
-  url: https://slack.cloudposse.com
+  - name: Latest Release
+    image: https://img.shields.io/github/release/cloudposse/terraform-aws-s3-log-storage.svg?style=for-the-badge
+    url: https://github.com/cloudposse/terraform-aws-s3-log-storage/releases/latest
+  - name: Last Updated
+    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-s3-log-storage.svg?style=for-the-badge
+    url: https://github.com/cloudposse/terraform-aws-s3-log-storage/commits
+  - name: Slack Community
+    image: https://slack.cloudposse.com/for-the-badge.svg
+    url: https://slack.cloudposse.com
+
+# List any related terraform modules that this module may be used with or that this module depends on.
 related:
-- name: terraform-aws-s3-bucket
-  description:  Terraform module that creates an S3 bucket with an optional IAM user for external CI/CD systems
-  url: https://github.com/cloudposse/terraform-aws-s3-bucket
-- name: terraform-aws-cloudfront-s3-cdn
-  description: Terraform module to easily provision CloudFront CDN backed by an S3
-    origin
-  url: https://github.com/cloudposse/terraform-aws-cloudfront-s3-cdn
-- name: terraform-aws-s3-website
-  description: Terraform Module for Creating S3 backed Websites and Route53 DNS
-  url: https://github.com/cloudposse/terraform-aws-s3-website
-- name: terraform-aws-user-data-s3-backend
-  description: Terraform Module to Offload User Data to S3
-  url: https://github.com/cloudposse/terraform-aws-user-data-s3-backend
-- name: terraform-aws-s3-logs-athena-query
-  description: A Terraform module that creates an Athena Database and Structure for
-    querying S3 access logs
-  url: https://github.com/cloudposse/terraform-aws-s3-logs-athena-query
-- name: terraform-aws-lb-s3-bucket
-  description: Terraform module to provision an S3 bucket with built in IAM policy
-    to allow AWS Load Balancers to ship access logs
-  url: https://github.com/cloudposse/terraform-aws-lb-s3-bucket
+  - name: terraform-aws-s3-bucket
+    description: Terraform module that creates an S3 bucket with an optional IAM user for external CI/CD systems
+    url: https://github.com/cloudposse/terraform-aws-s3-bucket
+  - name: terraform-aws-cloudfront-s3-cdn
+    description: Terraform module to easily provision CloudFront CDN backed by an S3 origin
+    url: https://github.com/cloudposse/terraform-aws-cloudfront-s3-cdn
+  - name: terraform-aws-s3-website
+    description: Terraform Module for Creating S3 backed Websites and Route53 DNS
+    url: https://github.com/cloudposse/terraform-aws-s3-website
+  - name: terraform-aws-user-data-s3-backend
+    description: Terraform Module to Offload User Data to S3
+    url: https://github.com/cloudposse/terraform-aws-user-data-s3-backend
+  - name: terraform-aws-s3-logs-athena-query
+    description: A Terraform module that creates an Athena Database and Structure for querying S3 access logs
+    url: https://github.com/cloudposse/terraform-aws-s3-logs-athena-query
+  - name: terraform-aws-lb-s3-bucket
+    description: Terraform module to provision an S3 bucket with built in IAM policy to allow AWS Load Balancers to ship access logs
+    url: https://github.com/cloudposse/terraform-aws-lb-s3-bucket
 description: |-
   This module creates an S3 bucket suitable for receiving logs from other `AWS` services such as `S3`, `CloudFront`, and `CloudTrails`.
 
@@ -53,20 +55,20 @@ description: |-
   It enables [default server-side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-encryption.html).
 
   It [blocks public access to the bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html) by default.
-  
+
   As of March, 2022, this module is primarily a wrapper around our 
   [s3-bucket](https://github.com/cloudposse/terraform-aws-s3-bucket)
   module, with some options preconfigured and SQS notifications added. If it does not exactly suit your needs,
   you may want to use the `s3-bucket` module directly.
-  
+
   As of version 1.0 of this module, most of the inputs are marked `nullable = false`, 
   meaning you can pass in `null` and get the default value rather than having the 
   input be actually set to `null`. This is technically a breaking change from previous versions,
   but since `null` was not a valid value for most of these variables, we are not considering it
   a truly breaking change. However, be mindful that the behavior of inputs set to `null`
   may change in the future, so we recommend setting them to the desired value explicitly.
 
-usage: |-
+usage: |2-
 
   This module supports full S3 [storage lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html)
   configuration via our [s3-bucket](https://github.com/cloudposse/terraform-aws-s3-bucket) module:
@@ -102,7 +104,7 @@ usage: |-
       }]
     }
   }
-  
+
   module "log_storage" {
     source = "cloudposse/s3-log-storage/aws"
     # Cloud Posse recommends pinning every module to a specific version
@@ -118,16 +120,6 @@ usage: |-
   ```
 
 include:
-- docs/targets.md
-- docs/terraform.md
-contributors:
-- name: Erik Osterman
-  github: osterman
-- name: Andriy Knysh
-  github: aknysh
-- name: Vladimir
-  github: SweetOps
-- name: Gonzalo Peci
-  github: pecigonzalo
-- name: Nuru
-  github: Nuru
+  - docs/targets.md
+  - docs/terraform.md
+contributors: []