From 6d9a50212b24f01f57822e3a87f4922be8d861e7 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Tue, 19 Dec 2023 17:26:42 +0000 Subject: [PATCH 01/11] chore: CLOUDP-215956 - Convert our bug report issue on GitHub to forms --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/bug_report.yml | 95 +++++++++++++++++++ README.md | 19 ++++ .../mongodbatlas-cloudformation-resources | 2 +- 4 files changed, 116 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 16335a7d..18ca648e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,5 +1,5 @@ --- -name: Bug report +name: Bug report [Deprecated] about: Create a report to help us improve title: '' labels: '' diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..4837690c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,95 @@ +name: Bug report [Recommended Template] +description: Something unexpected happen? Report an error, crash, or an incorrect behavior here. +title: "[Bug]: " +body: + - type: markdown + attributes: + value: | + Thank you for opening an issue. **These GitHub issues** are only for community reporting and assistance; as such, we don't have a guaranteed SLA. + + + **If you have an active MongoDB Atlas Support contract**, the best way for us to assist you with the AWS CDK MongoDB Atlas is through a support ticket. + + **Please note:** In order for us to provide the best experience in supporting our customers, we kindly ask to make sure that all the following sections are correctly filled with all the required information. + Our support will prioritise issues that contain all the required information that follows the [one-click reproducible issues principle](../../README.md#one-click-reproducible-issues-principle). + + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. If the issue has been reported add a reaction, i.e. +1, to the issue. + options: + - label: I have searched the existing issues + required: true + + - type: input + id: package_version + attributes: + label: CDK package version + description: What CDK Atlas package version are you running? + placeholder: "Example: v2.0.0" + validations: + required: true + + - type: input + id: cfn_resource_version + attributes: + label: CFN Resource version + description: What CFN resource version are you using in your AWS account? + placeholder: "Example: v1.6.6" + validations: + required: true + + - type: textarea + id: current_behaviour + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true + + - type: textarea + id: tf_config + attributes: + label: AWS CDK code to reproduce the issue + description: Please copy and paste your cdk code. This will be automatically formatted into code, so no need for backticks. + render: typescript + validations: + required: true + + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: true + + - type: textarea + id: logs + attributes: + label: cdk synth + description: Please copy and paste the outout of [`cdk synth`](https://cdkworkshop.com/30-python/20-create-project/400-synth.html) + render: shell + validations: + required: false + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](../../CODE_OF_CONDUCT.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true + + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. If the issue has been reported add a reaction, i.e. +1, to the issue. + options: + - label: I have searched the existing issues + required: true diff --git a/README.md b/README.md index acf54729..53b7bda8 100644 --- a/README.md +++ b/README.md @@ -99,3 +99,22 @@ Here are some examples of how to use this template: ## Contributing See our [CONTRIBUTING.md](CONTRIBUTING.md) guide. + +## Issues + +### Autoclose stale issues and PRs +- After 5 days of no activity (no comments or commits on an issue/PR) we automatically tag it as "stale" and add a message: ```This issue/PR has gone 5 days without any activity and meets the project's definition of "stale". This will be auto-closed if there is no new activity over the next 5 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!``` +- After 5 more days of no activity we automatically close the issue/PR. + +### One-click reproducible issues principle +Our support will prioritise issues that contain all the required information that follows the following principles: + +* We should be able to make no changes to your provided script and **successfully run a local execution reproducing the issue**. + * This means that you should kindly **provide all the required instructions**. This includes but not limited to: + * Terraform Atlas provider version used to reproduce the issue + * Terraform version used to reproduce the issue + * Configurations that **cannot be properly executed will be de-prioritised** in favour of the ones that succeed. +* Before opening an issue, you have to try to specifically isolate it to **Terraform MongoDB Atlas** provider by **removing as many dependencies** as possible. If the issue only happens with other dependencies, then: + * If other terraform providers are required, please make sure you also include those. _Same "one-click reproducible issue" principle applies_. + * If external components are required to replicate it, please make sure you also provides instructions on those parts. +* Please confirm if the platform being used is Terraform OSS, Terraform Cloud, or Terraform Enterprise deployment diff --git a/submodules/mongodbatlas-cloudformation-resources b/submodules/mongodbatlas-cloudformation-resources index e830daa6..7adebad0 160000 --- a/submodules/mongodbatlas-cloudformation-resources +++ b/submodules/mongodbatlas-cloudformation-resources @@ -1 +1 @@ -Subproject commit e830daa640f573c6fbe4d3df459790049462723d +Subproject commit 7adebad01b1abaccd85ef11826ffef482425fe4e From 4b0983ad6ddfe9e1d8272b14b41fbf3b2f9f8bd0 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Tue, 19 Dec 2023 18:01:13 +0000 Subject: [PATCH 02/11] Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 7 ------- 1 file changed, 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 4837690c..052dfe6f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -86,10 +86,3 @@ body: - label: I agree to follow this project's Code of Conduct required: true - - type: checkboxes - attributes: - label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the bug you encountered. If the issue has been reported add a reaction, i.e. +1, to the issue. - options: - - label: I have searched the existing issues - required: true From c2bfb5ceb0692b35d004dda8dafcbeef3160cc91 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Tue, 19 Dec 2023 18:03:22 +0000 Subject: [PATCH 03/11] Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 052dfe6f..4d80c3b2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -39,6 +39,15 @@ body: validations: required: true + - type: input + id: cfn_resource_region + attributes: + label: CFN Resource AWS Region + description: In which AWS Region are you running your CFN stack? + placeholder: "Example: v1.6.6" + validations: + required: true + - type: textarea id: current_behaviour attributes: From 4eac52aad7a32900df665f4c8a9ae2c15a1ee247 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Tue, 19 Dec 2023 18:03:56 +0000 Subject: [PATCH 04/11] Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 4d80c3b2..3bc17063 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -42,9 +42,9 @@ body: - type: input id: cfn_resource_region attributes: - label: CFN Resource AWS Region + label: CFN Resource Region description: In which AWS Region are you running your CFN stack? - placeholder: "Example: v1.6.6" + placeholder: "US-EAST-1" validations: required: true From 2ff1b51848bffcddc9457f7f17d953ef75a456d5 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Tue, 19 Dec 2023 18:06:48 +0000 Subject: [PATCH 05/11] Create config.yml --- .github/ISSUE_TEMPLATE/config.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..3f32cd49 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: true +contact_links: + - name: CFN/CDK Atlas Feature Request + url: https://feedback.mongodb.com/forums/924145-atlas?category_id=392596 + about: Request a feature or up-vote an existing suggestion! + - name: MongoDB Atlas Support + url: https://support.mongodb.com/ + about: Support is provided under MongoDB Atlas support plans. Please submit support questions within the Atlas UI. + - name: MongoDB Atlas + url: https://www.mongodb.com/cloud/atlas + about: Learn more about MongoDB Atlas From 0bde3fa00a38e035d00a543095e755107891c0ed Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Tue, 19 Dec 2023 18:10:32 +0000 Subject: [PATCH 06/11] Update API.md --- API.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/API.md b/API.md index 0ce34fcd..9aa11237 100644 --- a/API.md +++ b/API.md @@ -100,6 +100,25 @@ Here are some examples of how to use this template: ## Contributing See our [CONTRIBUTING.md](CONTRIBUTING.md) guide. +## Issues + +### Autoclose stale issues and PRs +- After 5 days of no activity (no comments or commits on an issue/PR) we automatically tag it as "stale" and add a message: ```This issue/PR has gone 5 days without any activity and meets the project's definition of "stale". This will be auto-closed if there is no new activity over the next 5 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!``` +- After 5 more days of no activity we automatically close the issue/PR. + +### One-click reproducible issues principle +Our support will prioritise issues that contain all the required information that follows the following principles: + +* We should be able to make no changes to your provided script and **successfully run a local execution reproducing the issue**. + * This means that you should kindly **provide all the required instructions**. This includes but not limited to: + * Terraform Atlas provider version used to reproduce the issue + * Terraform version used to reproduce the issue + * Configurations that **cannot be properly executed will be de-prioritised** in favour of the ones that succeed. +* Before opening an issue, you have to try to specifically isolate it to **Terraform MongoDB Atlas** provider by **removing as many dependencies** as possible. If the issue only happens with other dependencies, then: + * If other terraform providers are required, please make sure you also include those. _Same "one-click reproducible issue" principle applies_. + * If external components are required to replicate it, please make sure you also provides instructions on those parts. +* Please confirm if the platform being used is Terraform OSS, Terraform Cloud, or Terraform Enterprise deployment + # API Reference ## Constructs From 5ae72b663e7d570f2cdee3a48d1c8f77357b930b Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Tue, 19 Dec 2023 18:19:50 +0000 Subject: [PATCH 07/11] Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 3bc17063..6e4b6cb0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -44,7 +44,7 @@ body: attributes: label: CFN Resource Region description: In which AWS Region are you running your CFN stack? - placeholder: "US-EAST-1" + placeholder: "us-east-1" validations: required: true From 211ad77bebdd0b138414028887667ed7db88b2a8 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Tue, 19 Dec 2023 18:30:06 +0000 Subject: [PATCH 08/11] Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 6e4b6cb0..b2c7ddd0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -34,8 +34,8 @@ body: id: cfn_resource_version attributes: label: CFN Resource version - description: What CFN resource version are you using in your AWS account? - placeholder: "Example: v1.6.6" + description: What versions of CFN resources are you using in your AWS account? + placeholder: "Example: project: v1.6.6, cluster:v1.0.0" validations: required: true From 2d6f7cf7731f4495576374ec07a579be69876ef8 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Tue, 19 Dec 2023 19:29:59 +0000 Subject: [PATCH 09/11] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 53b7bda8..94fd5e5a 100644 --- a/README.md +++ b/README.md @@ -111,10 +111,10 @@ Our support will prioritise issues that contain all the required information tha * We should be able to make no changes to your provided script and **successfully run a local execution reproducing the issue**. * This means that you should kindly **provide all the required instructions**. This includes but not limited to: - * Terraform Atlas provider version used to reproduce the issue - * Terraform version used to reproduce the issue - * Configurations that **cannot be properly executed will be de-prioritised** in favour of the ones that succeed. -* Before opening an issue, you have to try to specifically isolate it to **Terraform MongoDB Atlas** provider by **removing as many dependencies** as possible. If the issue only happens with other dependencies, then: - * If other terraform providers are required, please make sure you also include those. _Same "one-click reproducible issue" principle applies_. + * AWS CDK package version used to reproduce the issue + * CFN resource version and AWS region used to reproduce the issue + * Issues that **cannot be properly reproduced will be de-prioritised** in favour of the ones that succeed. +* Before opening an issue, you have to try to specifically isolate it to the **CDK MongoDB Atlas constructur** by **removing as many dependencies** as possible. If the issue only happens with other dependencies, then: + * If other CDK constructors are required, please make sure you also include those. _Same "one-click reproducible issue" principle applies_. * If external components are required to replicate it, please make sure you also provides instructions on those parts. -* Please confirm if the platform being used is Terraform OSS, Terraform Cloud, or Terraform Enterprise deployment + From e0fa2e22a8434d5aede30b2138860662e5a44264 Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Tue, 19 Dec 2023 19:33:43 +0000 Subject: [PATCH 10/11] Update API.md --- API.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/API.md b/API.md index 9aa11237..b197a5d9 100644 --- a/API.md +++ b/API.md @@ -111,13 +111,13 @@ Our support will prioritise issues that contain all the required information tha * We should be able to make no changes to your provided script and **successfully run a local execution reproducing the issue**. * This means that you should kindly **provide all the required instructions**. This includes but not limited to: - * Terraform Atlas provider version used to reproduce the issue - * Terraform version used to reproduce the issue - * Configurations that **cannot be properly executed will be de-prioritised** in favour of the ones that succeed. -* Before opening an issue, you have to try to specifically isolate it to **Terraform MongoDB Atlas** provider by **removing as many dependencies** as possible. If the issue only happens with other dependencies, then: - * If other terraform providers are required, please make sure you also include those. _Same "one-click reproducible issue" principle applies_. + * AWS CDK package version used to reproduce the issue + * CFN resource version and AWS region used to reproduce the issue + * Issues that **cannot be properly reproduced will be de-prioritised** in favour of the ones that succeed. +* Before opening an issue, you have to try to specifically isolate it to the **CDK MongoDB Atlas constructur** by **removing as many dependencies** as possible. If the issue only happens with other dependencies, then: + * If other CDK constructors are required, please make sure you also include those. _Same "one-click reproducible issue" principle applies_. * If external components are required to replicate it, please make sure you also provides instructions on those parts. -* Please confirm if the platform being used is Terraform OSS, Terraform Cloud, or Terraform Enterprise deployment + # API Reference From fa3757d30ecd5b2aafeffc4eb2bad10ca676ae8f Mon Sep 17 00:00:00 2001 From: andreaangiolillo Date: Tue, 19 Dec 2023 19:35:19 +0000 Subject: [PATCH 11/11] typo --- API.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/API.md b/API.md index b197a5d9..5a8eb91b 100644 --- a/API.md +++ b/API.md @@ -114,7 +114,7 @@ Our support will prioritise issues that contain all the required information tha * AWS CDK package version used to reproduce the issue * CFN resource version and AWS region used to reproduce the issue * Issues that **cannot be properly reproduced will be de-prioritised** in favour of the ones that succeed. -* Before opening an issue, you have to try to specifically isolate it to the **CDK MongoDB Atlas constructur** by **removing as many dependencies** as possible. If the issue only happens with other dependencies, then: +* Before opening an issue, you have to try to specifically isolate it to the **CDK MongoDB Atlas constructor** by **removing as many dependencies** as possible. If the issue only happens with other dependencies, then: * If other CDK constructors are required, please make sure you also include those. _Same "one-click reproducible issue" principle applies_. * If external components are required to replicate it, please make sure you also provides instructions on those parts. diff --git a/README.md b/README.md index 94fd5e5a..f0589fa0 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ Our support will prioritise issues that contain all the required information tha * AWS CDK package version used to reproduce the issue * CFN resource version and AWS region used to reproduce the issue * Issues that **cannot be properly reproduced will be de-prioritised** in favour of the ones that succeed. -* Before opening an issue, you have to try to specifically isolate it to the **CDK MongoDB Atlas constructur** by **removing as many dependencies** as possible. If the issue only happens with other dependencies, then: +* Before opening an issue, you have to try to specifically isolate it to the **CDK MongoDB Atlas constructor** by **removing as many dependencies** as possible. If the issue only happens with other dependencies, then: * If other CDK constructors are required, please make sure you also include those. _Same "one-click reproducible issue" principle applies_. * If external components are required to replicate it, please make sure you also provides instructions on those parts.