From b901b3a675948f07cf3b581cc9359ef411b1882c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fatih=20T=C3=BCrken?= Date: Thu, 16 Nov 2023 16:58:13 +0300 Subject: [PATCH 1/2] Update bug report issue template MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fatih Türken --- .github/ISSUE_TEMPLATE/bug_report.md | 32 ------- .github/ISSUE_TEMPLATE/bug_report.yaml | 112 +++++++++++++++++++++++++ 2 files changed, 112 insertions(+), 32 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 92414377a0..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug Report -about: Help us diagnose and fix bugs in Official AWS Provider -labels: bug,needs:triage -title: ---- - - -### What happened? - - -### How can we reproduce it? - - -### What environment did it happen in? - -* Crossplane Version: -* Provider Version: -* Kubernetes Version: -* Kubernetes Distribution: diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000000..1765fdb832 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,112 @@ +name: Bug Report +description: Help us diagnose and fix bugs in Official AWS Provider +labels: bug,needs:triage +title: "[Bug]: " +body: + - type: markdown + attributes: + value: | + # Thank you for helping to improve Official AWS Provider! + + - If you're not currently using the most recent version of the Upbound Official AWS Provider, we recommend upgrading. This could resolve your issue, as any potential issues may have already been addressed in the latest release. + + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: | + Please be sure to search for open issues before raising a new one. + If there is an existing issue, please vote for it by adding a 👍 reaction to it to help us prioritize it. + options: + - label: I have searched the existing issues + required: true + + - type: textarea + id: affected + attributes: + label: Affected Resource(s) + description: Please fill the affected resource(s) "kind.groupname" + placeholder: "* kind.APIgroup=> Bucket.s3" + validations: + required: false + + - type: textarea + id: mr + attributes: + label: Resource MRs required to reproduce the bug + description: Please provide the example manifests and configurations you use. + validations: + required: true + + - type: textarea + id: repro + attributes: + label: Steps to Reproduce + description: Please list the steps required to reproduce the issue. + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What behavior do you expect? + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened? + validations: + required: true + + - type: textarea + id: log + attributes: + label: Relevant Error Output Snippet + description: | + If possible, provide a relevant log or screenshot from the error or panic output. + render: shell + validations: + required: false + + - type: input + id: crossplane_version + attributes: + label: Crossplane Version + placeholder: "X.Y.Z" + validations: + required: true + + - type: input + id: provider_version + attributes: + label: Provider Version + placeholder: "X.Y.Z" + validations: + required: true + + - type: input + id: kubernetes_version + attributes: + label: Kubernetes Version + placeholder: "use `kubectl version`" + validations: + required: false + + - type: input + id: kubernetes_distribution + attributes: + label: Kubernetes Distribution + placeholder: "EKS, AKS, GKE, OpenShift, etc." + validations: + required: false + + - type: textarea + id: additional_info + attributes: + label: Additional Info + description: The additional information you want to add, related issue(s), pull requests, reference documents, situations specific to your environment, etc. + validations: + required: false From d59e84f91719a9b6704c420df1d1982fe7bbd2cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fatih=20T=C3=BCrken?= Date: Mon, 15 Jan 2024 22:21:17 +0300 Subject: [PATCH 2/2] Add changes suggested in the review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fatih Türken --- .github/ISSUE_TEMPLATE/bug_report.yaml | 27 ++++++++++---------------- 1 file changed, 10 insertions(+), 17 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 1765fdb832..3938a48516 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -8,9 +8,10 @@ body: value: | # Thank you for helping to improve Official AWS Provider! - - If you're not currently using the most recent version of the Upbound Official AWS Provider, we recommend upgrading. This could resolve your issue, as any potential issues may have already been addressed in the latest release. + - If you're not currently using the most recent version of the Upbound Official AWS Provider, we recommend upgrading. Your issue might have already been addressed in the latest release. - type: checkboxes + id: existing_issue attributes: label: Is there an existing issue for this? description: | @@ -24,8 +25,8 @@ body: id: affected attributes: label: Affected Resource(s) - description: Please fill the affected resource(s) "kind.groupname" - placeholder: "* kind.APIgroup=> Bucket.s3" + description: Please provide the GVK of the affected resource(s). E.g. "ec2.aws.upbound.io/v1beta1 - Instance" + placeholder: "* ec2.aws.upbound.io/v1beta1 - Instance" validations: required: false @@ -35,7 +36,7 @@ body: label: Resource MRs required to reproduce the bug description: Please provide the example manifests and configurations you use. validations: - required: true + required: false - type: textarea id: repro @@ -46,18 +47,10 @@ body: required: true - type: textarea - id: expected - attributes: - label: Expected Behavior - description: What behavior do you expect? - validations: - required: true - - - type: textarea - id: actual + id: behavior attributes: - label: Actual Behavior - description: What actually happened? + label: What happened? + description: What difference did you observe in the actual behavior compared to what you expected? validations: required: true @@ -66,7 +59,7 @@ body: attributes: label: Relevant Error Output Snippet description: | - If possible, provide a relevant log or screenshot from the error or panic output. + If possible, provide a relevant log from the error or panic output. render: shell validations: required: false @@ -107,6 +100,6 @@ body: id: additional_info attributes: label: Additional Info - description: The additional information you want to add, related issue(s), pull requests, reference documents, situations specific to your environment, etc. + description: Any additional information you want to add, related issue(s), pull requests, document references, situations specific to your environment, etc. validations: required: false