diff --git a/.github/mergify.yml b/.github/mergify.yml index 148d85c..526045d 100644 --- 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 index c1642fe..9533e7e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # terraform-aws-efs -Latest ReleaseSlack Community +Latest ReleaseLast UpdatedSlack Community Terraform module to provision an AWS [`EFS`](https://aws.amazon.com/efs/) Network File System. - **NOTE**: Release `0.32.0` contains breaking changes. To preserve the SG, follow the instructions in the [0.30.1 to 0.32.x+ migration path](./docs/migration-0.30.1-0.32.x+.md). @@ -49,13 +48,11 @@ Terraform module to provision an AWS [`EFS`](https://aws.amazon.com/efs/) Networ ## Usage Include this repository as a module in your existing terraform code: - ```hcl module "efs" { source = "cloudposse/efs/aws" # Cloud Posse recommends pinning every module to a specific version # version = "x.x.x" - namespace = "eg" stage = "test" name = "app" @@ -63,7 +60,6 @@ module "efs" { vpc_id = var.vpc_id subnets = var.private_subnets zone_id = [var.aws_route53_dns_zone_id] - allowed_security_group_ids = [var.security_group_id] } ``` diff --git a/README.yaml b/README.yaml index c9aafc3..746672b 100644 --- a/README.yaml +++ b/README.yaml @@ -1,3 +1,4 @@ +--- # # This is the canonical configuration for the `README.md` # Run `make readme` to rebuild the `README.md` @@ -17,43 +18,42 @@ tags: categories: - terraform-modules/networking # Logo for this project -#logo: docs/logo.png +# logo: docs/logo.png # License of this project -license: "APACHE2" +license: APACHE2 # Canonical GitHub repo github_repo: cloudposse/terraform-aws-efs # Badges to display badges: - - name: "Latest Release" - image: "https://img.shields.io/github/release/cloudposse/terraform-aws-efs.svg" - url: "https://github.com/cloudposse/terraform-aws-efs/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-efs.svg?style=for-the-badge + url: https://github.com/cloudposse/terraform-aws-efs/releases/latest + - name: Last Updated + image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-efs.svg?style=for-the-badge + url: https://github.com/cloudposse/terraform-aws-efs/commits + - name: Slack Community + image: https://slack.cloudposse.com/for-the-badge.svg + url: https://slack.cloudposse.com related: - - name: "terraform-aws-efs-backup" - description: "Terraform module designed to easily backup EFS filesystems to S3 using DataPipeline" - url: "https://github.com/cloudposse/terraform-aws-efs-backup" - - name: "terraform-aws-efs-cloudwatch-sns-alarms" - description: "Terraform module that configures CloudWatch SNS alerts for EFS" - url: "https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms" + - name: terraform-aws-efs-backup + description: Terraform module designed to easily backup EFS filesystems to S3 using DataPipeline + url: https://github.com/cloudposse/terraform-aws-efs-backup + - name: terraform-aws-efs-cloudwatch-sns-alarms + description: Terraform module that configures CloudWatch SNS alerts for EFS + url: https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms # Short description of this project description: |- Terraform module to provision an AWS [`EFS`](https://aws.amazon.com/efs/) Network File System. - **NOTE**: Release `0.32.0` contains breaking changes. To preserve the SG, follow the instructions in the [0.30.1 to 0.32.x+ migration path](./docs/migration-0.30.1-0.32.x+.md). - # How to use this project usage: |- Include this repository as a module in your existing terraform code: - ```hcl module "efs" { source = "cloudposse/efs/aws" # Cloud Posse recommends pinning every module to a specific version # version = "x.x.x" - namespace = "eg" stage = "test" name = "app" @@ -61,30 +61,27 @@ usage: |- vpc_id = var.vpc_id subnets = var.private_subnets zone_id = [var.aws_route53_dns_zone_id] - allowed_security_group_ids = [var.security_group_id] } ``` - include: - - "docs/targets.md" - - "docs/terraform.md" + - docs/targets.md + - docs/terraform.md # Contributors to this project - contributors: - - name: "Erik Osterman" - github: "osterman" - - name: "Igor Rodionov" - github: "goruha" - - name: "Andriy Knysh" - github: "aknysh" - - name: "Sergey Vasilyev" - github: "s2504s" - - name: "Mike Eirih" - github: "maokomioko" - - name: "Josh Myers" - github: "joshmyers" - - name: "Vladimir Syromyatnikov" - github: "SweetOps" - - name: "RB" - github: "nitrocode" + - name: Erik Osterman + github: osterman + - name: Igor Rodionov + github: goruha + - name: Andriy Knysh + github: aknysh + - name: Sergey Vasilyev + github: s2504s + - name: Mike Eirih + github: maokomioko + - name: Josh Myers + github: joshmyers + - name: Vladimir Syromyatnikov + github: SweetOps + - name: RB + github: nitrocode