From 6fd3fb7dc002c9e5bf488284cd312240465cafcf Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Fri, 14 Jan 2022 14:04:33 -0600 Subject: [PATCH 01/19] Switch to Issue Forms --- .github/ISSUE_TEMPLATE/Bug_Report.md | 89 -------------------- .github/ISSUE_TEMPLATE/Feature_Request.md | 47 ----------- .github/ISSUE_TEMPLATE/bug_report.yml | 96 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 43 ++++++++++ 4 files changed, 139 insertions(+), 136 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/Bug_Report.md delete mode 100644 .github/ISSUE_TEMPLATE/Feature_Request.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/Bug_Report.md b/.github/ISSUE_TEMPLATE/Bug_Report.md deleted file mode 100644 index 3a7e41d0fa2..00000000000 --- a/.github/ISSUE_TEMPLATE/Bug_Report.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -name: 🐛 Bug Report -about: If something isn't working as expected 🤔. - ---- - - - - - -### Community Note - -* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request -* Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request -* If you are interested in working on this issue or have submitted a pull request, please leave a comment - - - -### Terraform CLI and Terraform AWS Provider Version - - - -### Affected Resource(s) - - - -* aws_XXXXX - -### Terraform Configuration Files - - - -Please include all Terraform configurations required to reproduce the bug. Bug reports without a functional reproduction may be closed without investigation. - -```hcl -# Copy-paste your Terraform configurations here - for large Terraform configs, -# please use a service like Dropbox and share a link to the ZIP file. For -# security, you can also encrypt the files using our GPG public key: https://keybase.io/hashicorp -``` - -### Debug Output - - - -### Panic Output - - - -### Expected Behavior - - - -### Actual Behavior - - - -### Steps to Reproduce - - - -1. `terraform apply` - -### Important Factoids - - - -### References - - - -* #0000 diff --git a/.github/ISSUE_TEMPLATE/Feature_Request.md b/.github/ISSUE_TEMPLATE/Feature_Request.md deleted file mode 100644 index f2fac266357..00000000000 --- a/.github/ISSUE_TEMPLATE/Feature_Request.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -name: 🚀 Feature Request -about: I have a suggestion (and might want to implement myself 🙂)! -labels: enhancement ---- - - - -### Community Note - -* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request -* Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request -* If you are interested in working on this issue or have submitted a pull request, please leave a comment - - - -### Description - - - -### New or Affected Resource(s) - - - -* aws_XXXXX - -### Potential Terraform Configuration - - - -```hcl -# Copy-paste your Terraform configurations here - for large Terraform configs, -# please use a service like Dropbox and share a link to the ZIP file. For -# security, you can also encrypt the files using our GPG public key. -``` - -### References - - - -* #0000 diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000000..ad6a1c83be3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,96 @@ +name: "🐛 Bug Report" +description: "If something isn't working as expected 🤔." +title: "[Bug]: " +labels: ["needs-triage"] +body: + - type: markdown + attributes: + value: "## Please note the following potential times when an issue might be in Terraform core:" + - type: markdown + attributes: + value: | + * [Configuration Language](https://www.terraform.io/docs/configuration/index.html) or resource ordering issues + * [State](https://www.terraform.io/docs/state/index.html) and [State Backend](https://www.terraform.io/docs/backends/index.html) issues + * [Provisioner](https://www.terraform.io/docs/provisioners/index.html) issues + * [Registry](https://registry.terraform.io/) issues + * Spans resources across multiple providers + + If you are running into one of these scenarios, we recommend opening an issue in the [Terraform core repository](https://github.com/hashicorp/terraform/) instead. + - type: textarea + attributes: + label: Community Note + description: Please leave this note as is for the community + value: | + * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request + * Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request + * If you are interested in working on this issue or have submitted a pull request, please leave a comment + validations: + required: true + - type: textarea + attributes: + label: Terraform CLI and Terraform AWS Provider Version + description: | + Please run `terraform -v` to show the Terraform core version and provider version(s). If you are not running the latest version of Terraform or the provider, please upgrade because your issue may have already been fixed. + + [Terraform documentation on provider versioning](https://www.terraform.io/docs/configuration/providers.html#provider-versions). + validations: + required: true + - type: textarea + attributes: + label: Affected Resource(s) + description: Please list the affected resource(s) and/or data source(s). + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: What should have happened? + validations: + required: true + - type: textarea + attributes: + label: Actual Behavior + description: What actually happened? + validations: + required: true + - type: textarea + attributes: + label: Terraform Configuration Files + description: | + Please include all Terraform configurations required to reproduce the bug. Bug reports without a functional reproduction may be closed without investigation. + + For large Terraform configurations, please use a service like Dropbox and share a link to the ZIP file. For your security you can also encrypt the files using our [GPG public key](https://keybase.io/hashicorp). + + [Information about code formatting](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code). + validations: + required: true + - type: textarea + attributes: + label: Debug Output + description: | + Please provide a link to a GitHub Gist containing the complete debug output. Please do NOT paste the debug output in the issue; just paste a link to the Gist. + + To obtain the debug output, see the [Terraform documentation on debugging](https://www.terraform.io/docs/internals/debugging.html). + validations: + required: true + - type: textarea + attributes: + label: Panic Output + description: If Terraform produced a panic, please provide a link to a GitHub Gist containing the output of the `crash.log`. + - type: textarea + attributes: + label: Steps to Reproduce + description: Please list the steps required to reproduce the issue. + validations: + required: true + - type: textarea + attributes: + label: Important Factoids + description: Are there anything atypical about your accounts that we should know? + - type: textarea + attributes: + label: References + description: | + Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor documentation? + + [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000000..e1deb6f7302 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,43 @@ +name: "🚀 Feature Request" +description: "I have a suggestion (and might want to implement myself 🙂)!" +title: "[Feature Request]: " +labels: ["enhancement"] +body: + - type: textarea + attributes: + label: Community Note + description: Please leave this note as is for the community + value: | + * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request + * Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request + * If you are interested in working on this issue or have submitted a pull request, please leave a comment + validations: + required: true + - type: textarea + attributes: + label: Description + description: Please leave a helpful description of the feature request here. + validations: + required: true + - type: textarea + attributes: + label: New or Affected Resource(s) + description: Please list the new or affected resource(s) and/or data source(s). + validations: + required: true + - type: textarea + attributes: + label: Potential Terraform Configuration + description: | + Copy-paste your Terraform configurations here. For large Terraform configs, please use a service like Dropbox and share a link to the ZIP file. For security, you can also encrypt the files using our [GPG public key](https://keybase.io/hashicorp). + + [Information about code formatting](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code). + validations: + required: true + - type: textarea + attributes: + label: References + description: | + Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor documentation? + + [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) From 24efc37e28f9d0df318d4d26e4f2b623c4a3d805 Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Fri, 14 Jan 2022 15:44:24 -0600 Subject: [PATCH 02/19] Add needs-triage label to feature request form --- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index e1deb6f7302..632eb98f795 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,7 +1,7 @@ name: "🚀 Feature Request" description: "I have a suggestion (and might want to implement myself 🙂)!" title: "[Feature Request]: " -labels: ["enhancement"] +labels: ["enhancement", "needs-triage"] body: - type: textarea attributes: From 100e6102424e622fa73e02fefe3a68cabda14c5e Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Tue, 18 Jan 2022 12:01:39 -0600 Subject: [PATCH 03/19] Capitalize "Terraform Core" Co-authored-by: Simon Davis --- .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 ad6a1c83be3..25a0222bd09 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -15,7 +15,7 @@ body: * [Registry](https://registry.terraform.io/) issues * Spans resources across multiple providers - If you are running into one of these scenarios, we recommend opening an issue in the [Terraform core repository](https://github.com/hashicorp/terraform/) instead. + If you are running into one of these scenarios, we recommend opening an issue in the [Terraform Core repository](https://github.com/hashicorp/terraform/) instead. - type: textarea attributes: label: Community Note From aee5a2739b00d01d03acdeb493e4a383de0cddba Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Fri, 28 Jan 2022 16:05:43 -0600 Subject: [PATCH 04/19] Adjust Actions for Forms --- .github/ISSUE_TEMPLATE/bug_report.yml | 10 ---------- .github/ISSUE_TEMPLATE/feature_request.yml | 10 ---------- .github/workflows/autoremove_labels.yml | 17 ++++++++++++++-- .github/workflows/issues.yml | 23 +++++++++++++--------- 4 files changed, 29 insertions(+), 31 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 25a0222bd09..72e906ba554 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -16,16 +16,6 @@ body: * Spans resources across multiple providers If you are running into one of these scenarios, we recommend opening an issue in the [Terraform Core repository](https://github.com/hashicorp/terraform/) instead. - - type: textarea - attributes: - label: Community Note - description: Please leave this note as is for the community - value: | - * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request - * Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request - * If you are interested in working on this issue or have submitted a pull request, please leave a comment - validations: - required: true - type: textarea attributes: label: Terraform CLI and Terraform AWS Provider Version diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 632eb98f795..430f1f9cd2c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -3,16 +3,6 @@ description: "I have a suggestion (and might want to implement myself 🙂)!" title: "[Feature Request]: " labels: ["enhancement", "needs-triage"] body: - - type: textarea - attributes: - label: Community Note - description: Please leave this note as is for the community - value: | - * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request - * Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request - * If you are interested in working on this issue or have submitted a pull request, please leave a comment - validations: - required: true - type: textarea attributes: label: Description diff --git a/.github/workflows/autoremove_labels.yml b/.github/workflows/autoremove_labels.yml index b8d718e9bbf..95344870751 100644 --- a/.github/workflows/autoremove_labels.yml +++ b/.github/workflows/autoremove_labels.yml @@ -1,11 +1,24 @@ name: Autoremove Labels on: issues: - types: [closed] + types: [closed, opened] pull_request_target: types: [closed] jobs: - remove-labels: + RemoveNeedsTriageFromMembers: + if: github.event.action == 'opened' + env: + ALLOW_LISTED: ${{ contains(fromJSON('["anGie44", "bflad", "breathingdust", "DrFaust92", "ewbankkit", "gdavison", "justinretzolk", "maryelizbeth", "YakDriver", "zhelding"]'), github.actor) }} + HAS_NEEDS_TRIAGE: ${{ contains(github.event.*.labels.*.name, 'needs-triage') }} + runs-on: ubuntu-latest + steps: + - name: Remove needs-triage label from member's Issues + if: ${{ env.ALLOW_LISTED == 'true' }} && ${{ env.HAS_NEEDS_TRIAGE == 'true' }} + uses: actions-ecosystem/action-remove-labels@v1 + with: + labels: 'needs-triage' + RemoveTriageLabelsFromClosed: + if: github.event.action == 'closed' runs-on: ubuntu-latest strategy: matrix: diff --git a/.github/workflows/issues.yml b/.github/workflows/issues.yml index 85320ce8065..c441ce4610a 100644 --- a/.github/workflows/issues.yml +++ b/.github/workflows/issues.yml @@ -3,20 +3,25 @@ on: types: [opened] name: Issue triage jobs: - markIssuesForTriage: + AddLabelsForIssueTriage: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - name: Apply Issue needs-triage Label - if: github.event.action == 'opened' && !contains(fromJSON('["anGie44", "bflad", "breathingdust", "DrFaust92", "ewbankkit", "gdavison", "justinretzolk", "maryelizbeth", "YakDriver", "zhelding"]'), github.actor) - uses: github/issue-labeler@v2.4 - with: - repo-token: "${{ secrets.GITHUB_TOKEN }}" - configuration-path: .github/labeler-issue-needs-triage.yml - enable-versioned-regex: 0 - name: Apply Issue Triage Labels uses: github/issue-labeler@v2.4 with: repo-token: "${{ secrets.GITHUB_TOKEN }}" configuration-path: .github/labeler-issue-triage.yml enable-versioned-regex: 0 + AddCommunityComment: + runs-on: ubuntu-latest + steps: + - uses: peter-evans/create-or-update-comment@v1 + name: Add community note to new issues + with: + issue-number: ${{ github.event.issue.number }} + body: | + **Community Note** + + * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request + * Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request + * If you are interested in working on this issue or have submitted a pull request, please leave a comment From fb3e67eec1f862f0212a33b9ce3c4dbb7044db91 Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Fri, 25 Feb 2022 15:23:31 -0600 Subject: [PATCH 05/19] Update allow list --- .github/workflows/autoremove_labels.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/autoremove_labels.yml b/.github/workflows/autoremove_labels.yml index 95344870751..f03bce57346 100644 --- a/.github/workflows/autoremove_labels.yml +++ b/.github/workflows/autoremove_labels.yml @@ -8,7 +8,7 @@ jobs: RemoveNeedsTriageFromMembers: if: github.event.action == 'opened' env: - ALLOW_LISTED: ${{ contains(fromJSON('["anGie44", "bflad", "breathingdust", "DrFaust92", "ewbankkit", "gdavison", "justinretzolk", "maryelizbeth", "YakDriver", "zhelding"]'), github.actor) }} + ALLOW_LISTED: ${{ contains(fromJSON('["anGie44", "bflad", "breathingdust", "ewbankkit", "gdavison", "johnsonaj", "justinretzolk", "maryelizbeth", "YakDriver", "zhelding"]'), github.actor) }} HAS_NEEDS_TRIAGE: ${{ contains(github.event.*.labels.*.name, 'needs-triage') }} runs-on: ubuntu-latest steps: From 509d8f43220213b45c21c608ac59950ea962347d Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Fri, 25 Feb 2022 15:47:34 -0600 Subject: [PATCH 06/19] Add placeholder, mark debug as optional --- .github/ISSUE_TEMPLATE/bug_report.yml | 13 ++++++++++++- .github/ISSUE_TEMPLATE/feature_request.yml | 1 + 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 72e906ba554..c916ac101d2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -23,12 +23,16 @@ body: Please run `terraform -v` to show the Terraform core version and provider version(s). If you are not running the latest version of Terraform or the provider, please upgrade because your issue may have already been fixed. [Terraform documentation on provider versioning](https://www.terraform.io/docs/configuration/providers.html#provider-versions). + placeholder: | + * Terraform: 1.1.6 + * AWS Provider: 4.2.0 validations: required: true - type: textarea attributes: label: Affected Resource(s) description: Please list the affected resource(s) and/or data source(s). + placeholder: "* aws_xxx" validations: required: true - type: textarea @@ -52,6 +56,10 @@ body: For large Terraform configurations, please use a service like Dropbox and share a link to the ZIP file. For your security you can also encrypt the files using our [GPG public key](https://keybase.io/hashicorp). [Information about code formatting](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code). + placeholder: | + ```hcl + provider "aws" {} + ``` validations: required: true - type: textarea @@ -62,7 +70,7 @@ body: To obtain the debug output, see the [Terraform documentation on debugging](https://www.terraform.io/docs/internals/debugging.html). validations: - required: true + required: false - type: textarea attributes: label: Panic Output @@ -71,6 +79,9 @@ body: attributes: label: Steps to Reproduce description: Please list the steps required to reproduce the issue. + placeholder: | + 1) Run `terraform apply` + 1) See errors validations: required: true - type: textarea diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 430f1f9cd2c..6ecafc9abf6 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -13,6 +13,7 @@ body: attributes: label: New or Affected Resource(s) description: Please list the new or affected resource(s) and/or data source(s). + placeholder: "* aws_xxx" validations: required: true - type: textarea From c7cf3ee003a88b24e09130e2e533160d4c6a0a34 Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Mon, 28 Feb 2022 14:34:50 -0600 Subject: [PATCH 07/19] Remove Brian from allow list --- .github/workflows/autoremove_labels.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/autoremove_labels.yml b/.github/workflows/autoremove_labels.yml index f03bce57346..932efc1f01d 100644 --- a/.github/workflows/autoremove_labels.yml +++ b/.github/workflows/autoremove_labels.yml @@ -8,7 +8,7 @@ jobs: RemoveNeedsTriageFromMembers: if: github.event.action == 'opened' env: - ALLOW_LISTED: ${{ contains(fromJSON('["anGie44", "bflad", "breathingdust", "ewbankkit", "gdavison", "johnsonaj", "justinretzolk", "maryelizbeth", "YakDriver", "zhelding"]'), github.actor) }} + ALLOW_LISTED: ${{ contains(fromJSON('["anGie44", "breathingdust", "ewbankkit", "gdavison", "johnsonaj", "justinretzolk", "maryelizbeth", "YakDriver", "zhelding"]'), github.actor) }} HAS_NEEDS_TRIAGE: ${{ contains(github.event.*.labels.*.name, 'needs-triage') }} runs-on: ubuntu-latest steps: From d1a61bd3eb9d6ff5e38c72c11df617312ef25f9c Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Wed, 9 Mar 2022 14:39:25 -0600 Subject: [PATCH 08/19] Use community comment action for PRs as well --- .github/PULL_REQUEST_TEMPLATE.md | 9 --------- .github/workflows/community-comment.yml | 19 +++++++++++++++++++ .github/workflows/issues.yml | 13 ------------- 3 files changed, 19 insertions(+), 22 deletions(-) create mode 100644 .github/workflows/community-comment.yml diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fea56fd896b..d9880a76edf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,14 +1,5 @@ - - -### Community Note - -* Please vote on this pull request by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original pull request comment to help the community and maintainers prioritize this request -* Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request - - - Relates OR Closes #0000 diff --git a/.github/workflows/community-comment.yml b/.github/workflows/community-comment.yml new file mode 100644 index 00000000000..eb11a6ffffa --- /dev/null +++ b/.github/workflows/community-comment.yml @@ -0,0 +1,19 @@ +on: + issues: + types: [opened] + pull_request_target: + types: [opened] +name: Add Community Note to Issues and PRs +jobs: + AddCommunityComment: + runs-on: ubuntu-latest + steps: + - uses: peter-evans/create-or-update-comment@v1 + name: Add community note to new issues + with: + issue-number: ${{ github.event.*.number }} + body: | + **Community Note** + * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request + * Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request + * If you are interested in working on this issue or have submitted a pull request, please leave a comment diff --git a/.github/workflows/issues.yml b/.github/workflows/issues.yml index c441ce4610a..11b8631e07d 100644 --- a/.github/workflows/issues.yml +++ b/.github/workflows/issues.yml @@ -12,16 +12,3 @@ jobs: repo-token: "${{ secrets.GITHUB_TOKEN }}" configuration-path: .github/labeler-issue-triage.yml enable-versioned-regex: 0 - AddCommunityComment: - runs-on: ubuntu-latest - steps: - - uses: peter-evans/create-or-update-comment@v1 - name: Add community note to new issues - with: - issue-number: ${{ github.event.issue.number }} - body: | - **Community Note** - - * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request - * Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request - * If you are interested in working on this issue or have submitted a pull request, please leave a comment From aa5be10bb273ae2ea5ee2102f9f29c38380ba155 Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Wed, 16 Mar 2022 15:42:32 -0500 Subject: [PATCH 09/19] Conform to new IN_MAINTAINER_LIST standard --- .github/workflows/autoremove_labels.yml | 27 +++++++++++++------------ 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/.github/workflows/autoremove_labels.yml b/.github/workflows/autoremove_labels.yml index 932efc1f01d..c4d0772c2c0 100644 --- a/.github/workflows/autoremove_labels.yml +++ b/.github/workflows/autoremove_labels.yml @@ -1,31 +1,32 @@ name: Autoremove Labels + on: issues: types: [closed, opened] pull_request_target: types: [closed] + +env: + IN_MAINTAINER_LIST: ${{ contains(secrets.MAINTAINER_LIST, github.actor) }} + jobs: - RemoveNeedsTriageFromMembers: + RemoveNeedsTriageFromMaintainers: if: github.event.action == 'opened' - env: - ALLOW_LISTED: ${{ contains(fromJSON('["anGie44", "breathingdust", "ewbankkit", "gdavison", "johnsonaj", "justinretzolk", "maryelizbeth", "YakDriver", "zhelding"]'), github.actor) }} - HAS_NEEDS_TRIAGE: ${{ contains(github.event.*.labels.*.name, 'needs-triage') }} runs-on: ubuntu-latest steps: - name: Remove needs-triage label from member's Issues - if: ${{ env.ALLOW_LISTED == 'true' }} && ${{ env.HAS_NEEDS_TRIAGE == 'true' }} + if: env.IN_MAINTAINER_LIST == 'true' uses: actions-ecosystem/action-remove-labels@v1 with: - labels: 'needs-triage' - RemoveTriageLabelsFromClosed: + labels: needs-triage + + RemoveTriagingLabelsFromClosedIssueOrPR: if: github.event.action == 'closed' runs-on: ubuntu-latest - strategy: - matrix: - labels: ['needs-triage', 'waiting-response'] steps: - - name: Remove ${{ matrix.labels }} label + - name: Remove triaging labels from closed issues and PRs uses: actions-ecosystem/action-remove-labels@v1 - if: contains(github.event.*.labels.*.name, matrix.labels) with: - labels: ${{ matrix.labels }} + labels: | + needs-triage + waiting-response From 0e692a7390a6d5aee6dae293d98d0066205154b3 Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Wed, 16 Mar 2022 15:51:33 -0500 Subject: [PATCH 10/19] Adjust formatting --- .github/workflows/autoremove_labels.yml | 5 +++-- .github/workflows/issues.yml | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/workflows/autoremove_labels.yml b/.github/workflows/autoremove_labels.yml index f4116addb14..99488ec8661 100644 --- a/.github/workflows/autoremove_labels.yml +++ b/.github/workflows/autoremove_labels.yml @@ -18,7 +18,8 @@ jobs: if: env.IN_MAINTAINER_LIST == 'true' uses: actions-ecosystem/action-remove-labels@v1 with: - labels: needs-triage + labels: | + needs-triage RemoveTriagingLabelsFromClosedIssueOrPR: if: github.event.action == 'closed' @@ -29,4 +30,4 @@ jobs: with: labels: | needs-triage - waiting-response \ No newline at end of file + waiting-response diff --git a/.github/workflows/issues.yml b/.github/workflows/issues.yml index bb776c84aa7..75968b3b9b8 100644 --- a/.github/workflows/issues.yml +++ b/.github/workflows/issues.yml @@ -6,7 +6,7 @@ on: env: IN_MAINTAINER_LIST: ${{ contains(secrets.MAINTAINER_LIST, github.actor) }} - + jobs: AddLabelsForIssueTriage: runs-on: ubuntu-latest @@ -16,4 +16,4 @@ jobs: with: repo-token: "${{ secrets.GITHUB_TOKEN }}" configuration-path: .github/labeler-issue-triage.yml - enable-versioned-regex: 0 \ No newline at end of file + enable-versioned-regex: 0 From aa61a05f1949f3a8b1d613f2d3d1c066f70ebb7e Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Wed, 7 Sep 2022 17:11:31 -0500 Subject: [PATCH 11/19] Forms rewrite --- .github/ISSUE_TEMPLATE/00_bug_report.yml | 178 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/01_documentation.yml | 52 ++++++ .github/ISSUE_TEMPLATE/02_enhancement.yml | 64 +++++++ .github/ISSUE_TEMPLATE/03_new_resource.yml | 74 ++++++++ .github/ISSUE_TEMPLATE/04_repository.yml | 42 +++++ .github/ISSUE_TEMPLATE/05_other.yml | 49 ++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 97 ----------- .github/ISSUE_TEMPLATE/feature_request.yml | 34 ---- 8 files changed, 459 insertions(+), 131 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/00_bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/01_documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/02_enhancement.yml create mode 100644 .github/ISSUE_TEMPLATE/03_new_resource.yml create mode 100644 .github/ISSUE_TEMPLATE/04_repository.yml create mode 100644 .github/ISSUE_TEMPLATE/05_other.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/00_bug_report.yml b/.github/ISSUE_TEMPLATE/00_bug_report.yml new file mode 100644 index 00000000000..a584d686845 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/00_bug_report.yml @@ -0,0 +1,178 @@ +name: "Report a Bug" +description: "Choose this option to let us know about an unexpected error, a crash, or otherwise incorrect behavior." +title: "[Bug]: " +labels: ["bug", "needs-triage"] +body: + - type: markdown + attributes: + value: | + # Thank you for raising a bug report! + + Before submitting a bug report, we ask that you first search existing issues to see if someone else may have experienced the same issue. This helps to keep all relevant information in one place, including any potential workarounds. + + We also ask that you consider whether your issue may be related to Terraform Core. If you are running into one of the following scenarios, we recommend [opening an issue](https://github.com/hashicorp/terraform/issues/new/choose) in the Terraform Core repository instead: + + * [Configuration Language](https://www.terraform.io/docs/configuration/index.html) or resource ordering issues + * [State](https://www.terraform.io/docs/state/index.html) and [State Backend](https://www.terraform.io/docs/backends/index.html) issues + * [Provisioner](https://www.terraform.io/docs/provisioners/index.html) issues + * [Registry](https://registry.terraform.io/) issues + * Spans resources across multiple providers + + - type: markdown + attributes: + value: | + # Terraform and AWS Provider Versions + + Please run `terraform -v` to show the Terraform Core and provider version(s). If you are not running the latest version of either the provider or Terraform Core, please consider upgrading, as your issue may have already been fixed. + + [Terraform documentation on provider versioning](https://www.terraform.io/docs/configuration/providers.html#provider-versions) + + - type: input + id: tf_version + attributes: + label: Terraform Core Version + description: The semantic version of Terraform Core used when experiencing the bug. If multiple versions have been tested, a comma separated list. + placeholder: "X.Y.Z" + validations: + required: true + + - type: input + id: aws_version + attributes: + label: AWS Provider Version + description: The semantic version of the AWS Provider used when experiencing the bug. If multiple versions have been tested, a comma separated list. + placeholder: "X.Y.Z" + validations: + required: true + + - type: markdown + attributes: + value: | + # Description + + In the next few fields, please provide any useful information you can around what resources are affected, what you expected to happen, and what actually happened. There is also a field to optionally provide a small snippet of any relevant error or panic output. + + Note that there is a section later in the form to provide more complete Terraform configuration and logging information. These fields should instead be thought of as the place to briefly describe the bug. + + - type: textarea + id: affected + attributes: + label: Affected Resource(s) + description: Please list the affected resource(s) and/or data source(s). + placeholder: "* aws_xxx" + validations: + required: false + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What should have happened? + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened? + validations: + required: true + + - type: textarea + id: log_snippet + attributes: + label: Relevant Error/Panic Output Snippet + description: | + If applicable, provide a relevant snippet from the error or panic output. This will be rendered as `shell`, so there is no need to add a [code fence](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks). + render: shell + validations: + required: false + + - type: markdown + attributes: + value: | + # Configuration and Logging + + Here, we ask that you provide the Terraform configuration and, when possible, the debug logs. For configurations or logs of more than just a few lines, it's preferred to either share a Gist link or zip the files and upload them. + + Terraform configurations or debug logs under 25MB may be [attached directly in the field](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files). Files larger than this should be uploaded to a file hosting service and a link shared. + + For your security you can also encrypt the files using our [GPG public key](https://keybase.io/hashicorp). + + **Note:** These form fields do not automatically render, so you will need to use [code fence(s)](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code) to achieve proper formatting. + + - type: textarea + id: tf_config + attributes: + label: Terraform Configuration Files + description: | + Please paste, upload, or link to a file or Gist containing all Terraform configurations required to reproduce the bug. See note above for additional information on file size restrictions and encrypting. + + Bug reports without a functional reproduction may be closed without investigation. + 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: debug_logs + attributes: + label: Debug Output + description: | + If possible, please paste, upload, or link to a file or Gist containing debug logs. See note above for additional information on file size restrictions and encrypting. + + To obtain the debug output, see the [Terraform documentation on debugging](https://www.terraform.io/docs/internals/debugging.html). + validations: + required: false + + - type: textarea + id: panic_logs + attributes: + label: Panic Output + description: If Terraform produced a panic, please paste, upload, or link to a file or Gist containing the output of the `crash.log`. + validations: + required: false + + - type: markdown + attributes: + value: | + # Additional Information + + For the final two fields, optionally provide any additional context that might help the community or maintainers to investigate the bug. This might be additional references that you found when troubleshooting, similar bug reports, or specifics about your environment that might be unique. + + - type: textarea + attributes: + label: Important Factoids + description: Are there anything atypical about your configuration or environment that we should know about? + validations: + required: false + + - type: textarea + id: references + attributes: + label: References + description: | + Where possible, please supply links to vendor documentation, other GitHub issues (open or closed) or pull requests that give additional context. + + [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) + validations: + required: false + + - type: dropdown + id: will_contribute + attributes: + label: Would you like to implement a fix? + description: | + If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. + options: + - "No" + - "Yes" + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/01_documentation.yml b/.github/ISSUE_TEMPLATE/01_documentation.yml new file mode 100644 index 00000000000..cbbd6065257 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_documentation.yml @@ -0,0 +1,52 @@ +name: "Report a Documentation Error" +description: "Choose this option if you've found an error in the provider documentation or contribution guides." +title: "[Docs]: " +labels: ["documentation", "needs-triage"] +body: + - type: markdown + attributes: + value: | + # Thank you for raising a documentation issue! + + This form is meant to alert the maintainers to an issue with the provider documentation found on the [Terraform Registry](https://registry.terraform.io/providers/hashicorp/aws/latest) (such as resource and data source documentation, guides and examples), as well as the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/). + + Documentation edits are generally a bit less involved, so are often a great entrypoint if you've ever been interested in [contributing](https://hashicorp.github.io/terraform-provider-aws/documentation-changes/)! + + - type: input + id: registry_link + attributes: + label: Documentation Link + description: Please provide a link to the affected page on the Terraform Registry or contribution guide. + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: Please leave a brief description of the documentation issue. + validations: + required: true + + - type: textarea + id: references + attributes: + label: References + description: | + Where possible, please supply links to vendor documentation, other GitHub issues (open or closed) or pull requests that give additional context. + + [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) + validations: + required: false + + - type: dropdown + id: will_contribute + attributes: + label: Would you like to implement a fix? + description: | + If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. + options: + - "No" + - "Yes" + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/02_enhancement.yml b/.github/ISSUE_TEMPLATE/02_enhancement.yml new file mode 100644 index 00000000000..16e5d06496c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_enhancement.yml @@ -0,0 +1,64 @@ +name: "Request an Enhancement" +description: "Choose this option when you would like to request an enhancement to an existing resource, data source, or the provider itself." +title: "[Enhancement]: " +labels: ["enhancement", "needs-triage"] +body: + - type: markdown + attributes: + value: | + # Thank you for opening an enhancement request! + + This form is intended as a way to request additional functionality for existing resources, data sources, or the provider itself. This may include requests such as adding additional arguments or attributes enabled by upstream API changes, additional validation for arguments, etc. + + If the absense of the requested feature is causing unexpected behavior in the provider, the "Report a Bug" form should be used. For entirely new resources, data sources, or services, please use the Request a "New Resource, Data Source, or AWS Service" form. + + - type: textarea + id: description + attributes: + label: Description + description: Please leave a brief description of the requested change. + validations: + required: true + + - type: textarea + id: affected + attributes: + label: Affected Resource(s) and/or Data Source(s) + placeholder: "* aws_xxx_yyy" + validations: + required: false + + - type: textarea + id: tf_config + attributes: + label: Potential Terraform Configuration + description: | + If this request was implemented, what might the Terraform configuration look like? A best guess is helpful, even if you're unsure of exactly what the end result will look like. This helps maintainers and the community better understand how you (someone who is in need of this feature) envisions it. + + **Note:** This field will render in HCL, so there is no need to add a [code fence](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks). + render: terraform + validations: + required: false + + - type: textarea + id: references + attributes: + label: References + description: | + Where possible, please supply links to vendor documentation, other GitHub issues (open or closed) or pull requests that give additional context. + + [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) + validations: + required: false + + - type: dropdown + id: will_contribute + attributes: + label: Would you like to implement a fix? + description: | + If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. + options: + - "No" + - "Yes" + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/03_new_resource.yml b/.github/ISSUE_TEMPLATE/03_new_resource.yml new file mode 100644 index 00000000000..cd10fdbd5a8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03_new_resource.yml @@ -0,0 +1,74 @@ +name: "Request a New Resource, Data Source, or AWS Service" +description: "Choose this option to request an entirely new resource, data source, or AWS service be added to the provider." +title: "[New]: " +labels: ["needs-triage"] +body: + - type: markdown + attributes: + value: | + # Thank you for opening a request! + + This form is intended to be used when requesting an entirely new resource, data source, or service be added to the provider. If you're looking for a change to be made to an existing resource or data source, consider submitting either the "Request an Enhancement" or Report a Bug" forms instead. + + When possible, it's helpful to check the [AWS Go SDK](https://pkg.go.dev/github.com/aws/aws-sdk-go/service) or [AWS Go SDK v2](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2#section-directories) to determine whether functionality exists to enable the requested feature. It is **not** required that you do this. Any references found when searching can be added to the "References" field below to give maintainers or the community a head start. + + Please update the title to match what you're requesting, e.g.: + + - `[New Resource]:` - for new resource requests + - `[New Data Source]:` - for new data source requests + - `[New Service]:` - for new AWS services + + - type: textarea + id: description + attributes: + label: Description + description: Please leave a brief description of what you're requesting. + validations: + required: true + + - type: textarea + id: resources + attributes: + label: Requested Resource(s) and/or Data Source(s) + description: | + Please list any new resource(s) and/or data source(s). The naming format is `aws__`, e.g., `aws_lambda_function`. + + A best guess is helpful, even if you're unsure of exactly what the end result will look like. This helps maintainers and the community better understand how you (someone who is in need of this request) envisions it. + placeholder: "* aws_xxx_yyy" + validations: + required: true + + - type: textarea + id: tf_config + attributes: + label: Potential Terraform Configuration + description: | + If this request was implemented, what might the Terraform configuration look like? Similar to above, a best guess is helpful, even if you're unsure of exactly what the end result will look like. + + **Note:** This field will render in HCL, so there is no need to add a [code fence](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks). + render: terraform + validations: + required: false + + - type: textarea + id: references + attributes: + label: References + description: | + Where possible, please supply links to vendor documentation, other GitHub issues (open or closed) or pull requests that give additional context. + + [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) + validations: + required: false + + - type: dropdown + id: will_contribute + attributes: + label: Would you like to implement a fix? + description: | + If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. + options: + - "No" + - "Yes" + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/04_repository.yml b/.github/ISSUE_TEMPLATE/04_repository.yml new file mode 100644 index 00000000000..2137fe988f0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04_repository.yml @@ -0,0 +1,42 @@ +name: "Repository/Meta" +description: Choose this option when the issue has to do with the repository itself, including GitHub Actions, labels, workflows, etc. +title: "[Repo]: " +labels: ["repository", "needs-triage"] +body: + - type: markdown + attributes: + value: | + # Thank you for opening an issue! + + This form is for issues pertaining to the repository itself. This might include changes to GitHub Actions, labels, procedures, etc. For issues with the contribution documentation, please use the "Report a Documentation Error" form. + + - type: textarea + id: description + attributes: + label: Description + description: Please leave a brief description of the issue or proposed change. + validations: + required: true + + - type: textarea + id: references + attributes: + label: References + description: | + Where possible, please supply links to vendor documentation, other GitHub issues (open or closed) or pull requests that give additional context. + + [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) + validations: + required: false + + - type: dropdown + id: will_contribute + attributes: + label: Would you like to implement a fix? + description: | + If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. + options: + - "No" + - "Yes" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/05_other.yml b/.github/ISSUE_TEMPLATE/05_other.yml new file mode 100644 index 00000000000..571a29bddce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/05_other.yml @@ -0,0 +1,49 @@ +name: "Other" +description: "Choose this option if your issue does not fit the description of the others." +labels: ["needs-triage"] +body: + - type: markdown + attributes: + value: | + # Thank you for raising an issue! + + This form is meant as a catch-all for issues that do not fit into one of the other existing forms: + + * Report a Bug + * Report a Documentation Error + * Request an Enhancement + * Request a New Resource, Data Source, or AWS Service + * Repository/Meta + + By nature this form is less rigid, so providing a bit of additional information, context, or reference material is very much appreciated. + + - type: textarea + id: description + attributes: + label: Description + description: Please leave a detailed description of the issue. + validations: + required: true + + - type: textarea + id: references + attributes: + label: References + description: | + Where possible, please supply links to vendor documentation, other GitHub issues (open or closed) or pull requests that give additional context. + + [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) + validations: + required: false + + - type: dropdown + id: will_contribute + attributes: + label: Would you like to implement a fix? + description: | + If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. + options: + - "No" + - "Yes" + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index c916ac101d2..00000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,97 +0,0 @@ -name: "🐛 Bug Report" -description: "If something isn't working as expected 🤔." -title: "[Bug]: " -labels: ["needs-triage"] -body: - - type: markdown - attributes: - value: "## Please note the following potential times when an issue might be in Terraform core:" - - type: markdown - attributes: - value: | - * [Configuration Language](https://www.terraform.io/docs/configuration/index.html) or resource ordering issues - * [State](https://www.terraform.io/docs/state/index.html) and [State Backend](https://www.terraform.io/docs/backends/index.html) issues - * [Provisioner](https://www.terraform.io/docs/provisioners/index.html) issues - * [Registry](https://registry.terraform.io/) issues - * Spans resources across multiple providers - - If you are running into one of these scenarios, we recommend opening an issue in the [Terraform Core repository](https://github.com/hashicorp/terraform/) instead. - - type: textarea - attributes: - label: Terraform CLI and Terraform AWS Provider Version - description: | - Please run `terraform -v` to show the Terraform core version and provider version(s). If you are not running the latest version of Terraform or the provider, please upgrade because your issue may have already been fixed. - - [Terraform documentation on provider versioning](https://www.terraform.io/docs/configuration/providers.html#provider-versions). - placeholder: | - * Terraform: 1.1.6 - * AWS Provider: 4.2.0 - validations: - required: true - - type: textarea - attributes: - label: Affected Resource(s) - description: Please list the affected resource(s) and/or data source(s). - placeholder: "* aws_xxx" - validations: - required: true - - type: textarea - attributes: - label: Expected Behavior - description: What should have happened? - validations: - required: true - - type: textarea - attributes: - label: Actual Behavior - description: What actually happened? - validations: - required: true - - type: textarea - attributes: - label: Terraform Configuration Files - description: | - Please include all Terraform configurations required to reproduce the bug. Bug reports without a functional reproduction may be closed without investigation. - - For large Terraform configurations, please use a service like Dropbox and share a link to the ZIP file. For your security you can also encrypt the files using our [GPG public key](https://keybase.io/hashicorp). - - [Information about code formatting](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code). - placeholder: | - ```hcl - provider "aws" {} - ``` - validations: - required: true - - type: textarea - attributes: - label: Debug Output - description: | - Please provide a link to a GitHub Gist containing the complete debug output. Please do NOT paste the debug output in the issue; just paste a link to the Gist. - - To obtain the debug output, see the [Terraform documentation on debugging](https://www.terraform.io/docs/internals/debugging.html). - validations: - required: false - - type: textarea - attributes: - label: Panic Output - description: If Terraform produced a panic, please provide a link to a GitHub Gist containing the output of the `crash.log`. - - type: textarea - attributes: - label: Steps to Reproduce - description: Please list the steps required to reproduce the issue. - placeholder: | - 1) Run `terraform apply` - 1) See errors - validations: - required: true - - type: textarea - attributes: - label: Important Factoids - description: Are there anything atypical about your accounts that we should know? - - type: textarea - attributes: - label: References - description: | - Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor documentation? - - [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml deleted file mode 100644 index 6ecafc9abf6..00000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,34 +0,0 @@ -name: "🚀 Feature Request" -description: "I have a suggestion (and might want to implement myself 🙂)!" -title: "[Feature Request]: " -labels: ["enhancement", "needs-triage"] -body: - - type: textarea - attributes: - label: Description - description: Please leave a helpful description of the feature request here. - validations: - required: true - - type: textarea - attributes: - label: New or Affected Resource(s) - description: Please list the new or affected resource(s) and/or data source(s). - placeholder: "* aws_xxx" - validations: - required: true - - type: textarea - attributes: - label: Potential Terraform Configuration - description: | - Copy-paste your Terraform configurations here. For large Terraform configs, please use a service like Dropbox and share a link to the ZIP file. For security, you can also encrypt the files using our [GPG public key](https://keybase.io/hashicorp). - - [Information about code formatting](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code). - validations: - required: true - - type: textarea - attributes: - label: References - description: | - Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor documentation? - - [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) From d8781ffa4f8ae015b807aa55b71cf39a8d9c97ed Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Wed, 7 Sep 2022 17:11:56 -0500 Subject: [PATCH 12/19] Update formatting in config --- .github/ISSUE_TEMPLATE/config.yml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index e0c19b0d3f2..2212c21eb50 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,14 +1,17 @@ blank_issues_enabled: false contact_links: - - name: Terraform AWS Provider Roadmap - url: https://github.com/hashicorp/terraform-provider-aws/blob/main/ROADMAP.md - about: View the Roadmap for the upcoming work planned on the AWS provider. - name: Terraform AWS Provider Questions url: https://discuss.hashicorp.com/c/terraform-providers/tf-aws about: GitHub issues in this repository are only intended for bug reports and feature requests. Other issues will be closed. Please ask and answer questions through the Terraform AWS Provider Community Forum. + - name: Terraform Core Bug Reports and Feature Requests url: https://github.com/hashicorp/terraform/issues/new/choose about: Terraform Core, which handles the Terraform configuration language, CLI commands, and resource dependency graph, has its own codebase. Bug reports and feature requests for those pieces of functionality should be directed to that repository. + - name: Terraform Language or Workflow Questions url: https://discuss.hashicorp.com/c/terraform-core about: Please ask and answer language or workflow related questions through the Terraform Core Community Forum. + + - name: Terraform AWS Provider Roadmap + url: https://github.com/hashicorp/terraform-provider-aws/blob/main/ROADMAP.md + about: View the Roadmap for the upcoming work planned on the AWS provider. \ No newline at end of file From c20713e1c701864cf121c18c1ea3369d78320b58 Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Wed, 7 Sep 2022 17:12:04 -0500 Subject: [PATCH 13/19] Update Actions --- .github/workflows/autoremove_labels.yml | 2 +- .github/workflows/community-comment.yml | 48 ++++++++++++++++++++----- 2 files changed, 40 insertions(+), 10 deletions(-) diff --git a/.github/workflows/autoremove_labels.yml b/.github/workflows/autoremove_labels.yml index 99488ec8661..4639ef91f0b 100644 --- a/.github/workflows/autoremove_labels.yml +++ b/.github/workflows/autoremove_labels.yml @@ -15,7 +15,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Remove needs-triage label from member's Issues - if: env.IN_MAINTAINER_LIST == 'true' + if: fromJSON(env.IN_MAINTAINER_LIST) uses: actions-ecosystem/action-remove-labels@v1 with: labels: | diff --git a/.github/workflows/community-comment.yml b/.github/workflows/community-comment.yml index eb11a6ffffa..ff8bb0b68ad 100644 --- a/.github/workflows/community-comment.yml +++ b/.github/workflows/community-comment.yml @@ -1,19 +1,49 @@ on: - issues: + issues: types: [opened] - pull_request_target: + pull_request_target: types: [opened] + name: Add Community Note to Issues and PRs + jobs: AddCommunityComment: runs-on: ubuntu-latest steps: - - uses: peter-evans/create-or-update-comment@v1 - name: Add community note to new issues + - name: Add community note to new Issues + if: github.event_name == 'issues' + uses: peter-evans/create-or-update-comment@v1 with: - issue-number: ${{ github.event.*.number }} + issue-number: ${{ github.event.issue.number }} body: | - **Community Note** - * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request - * Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request - * If you are interested in working on this issue or have submitted a pull request, please leave a comment + # Community Note + + **Voting for Prioritization** + + * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original post to help the community and maintainers prioritize this request. + * Please see our [prioritization guide](https://hashicorp.github.io/terraform-provider-aws/prioritization/) for information on how we prioritize. + * Please **do not** leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request. + + **Volunteering to Work on This Issue** + + * If you are interested in working on this issue, please leave a comment. + * If this would be your first contribution, please review the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/). + + - name: Add community note to new Pull Requests + uses: peter-evans/create-or-update-comment@v1 + if: github.event_name == 'pull_request_target' + with: + issue-number: ${{ github.event.pull_request.number }} + body: | + # Community Note + + **Voting for Prioritization** + + * Please vote on this pull request by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original post to help the community and maintainers prioritize this pull request. + * Please see our [prioritization guide](https://hashicorp.github.io/terraform-provider-aws/prioritization/) for information on how we prioritize. + * Please **do not** leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request. + + **For Submitters** + + * Please review the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) relating to the type of change you are making to ensure all of the necessary steps have been taken. + * Whether or not the branch has been rebased will **not** impact prioritization, but doing so is always a welcome surprise. \ No newline at end of file From cb9367ced9cae2cb7ee5a95184ad12ec966ac807 Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Wed, 7 Sep 2022 17:15:39 -0500 Subject: [PATCH 14/19] Minor PR template tweak --- .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d9880a76edf..89c850e539e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,14 @@ - + +If your PR fully resolves and should automatically close the linked issue, use Closes. Otherwise, use Relates + +For Example: + +Relates #0000 +or +Closes #0000 +---> Relates OR Closes #0000 Output from acceptance testing: From a7d30f2bc09467f4e95dfb98600ca66e70c1ab65 Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Wed, 7 Sep 2022 17:35:04 -0500 Subject: [PATCH 15/19] Attempt to fix YAML --- .github/workflows/community-comment.yml | 60 ++++++++++++------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/.github/workflows/community-comment.yml b/.github/workflows/community-comment.yml index ff8bb0b68ad..3c8b7ed6315 100644 --- a/.github/workflows/community-comment.yml +++ b/.github/workflows/community-comment.yml @@ -1,7 +1,7 @@ on: - issues: + issues: types: [opened] - pull_request_target: + pull_request_target: types: [opened] name: Add Community Note to Issues and PRs @@ -10,40 +10,40 @@ jobs: AddCommunityComment: runs-on: ubuntu-latest steps: - - name: Add community note to new Issues - if: github.event_name == 'issues' - uses: peter-evans/create-or-update-comment@v1 - with: - issue-number: ${{ github.event.issue.number }} - body: | - # Community Note + - name: Add community note to new Issues + if: github.event_name == 'issues' + uses: peter-evans/create-or-update-comment@v1 + with: + issue-number: ${{ github.event.issue.number }} + body: | + # Community Note - **Voting for Prioritization** + **Voting for Prioritization** - * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original post to help the community and maintainers prioritize this request. - * Please see our [prioritization guide](https://hashicorp.github.io/terraform-provider-aws/prioritization/) for information on how we prioritize. - * Please **do not** leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request. + * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original post to help the community and maintainers prioritize this request. + * Please see our [prioritization guide](https://hashicorp.github.io/terraform-provider-aws/prioritization/) for information on how we prioritize. + * Please **do not** leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request. - **Volunteering to Work on This Issue** + **Volunteering to Work on This Issue** - * If you are interested in working on this issue, please leave a comment. - * If this would be your first contribution, please review the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/). + * If you are interested in working on this issue, please leave a comment. + * If this would be your first contribution, please review the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/). - - name: Add community note to new Pull Requests - uses: peter-evans/create-or-update-comment@v1 - if: github.event_name == 'pull_request_target' - with: - issue-number: ${{ github.event.pull_request.number }} - body: | - # Community Note + - name: Add community note to new Pull Requests + uses: peter-evans/create-or-update-comment@v1 + if: github.event_name == 'pull_request_target' + with: + issue-number: ${{ github.event.pull_request.number }} + body: | + # Community Note - **Voting for Prioritization** + **Voting for Prioritization** - * Please vote on this pull request by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original post to help the community and maintainers prioritize this pull request. - * Please see our [prioritization guide](https://hashicorp.github.io/terraform-provider-aws/prioritization/) for information on how we prioritize. - * Please **do not** leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request. + * Please vote on this pull request by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original post to help the community and maintainers prioritize this pull request. + * Please see our [prioritization guide](https://hashicorp.github.io/terraform-provider-aws/prioritization/) for information on how we prioritize. + * Please **do not** leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request. - **For Submitters** + **For Submitters** - * Please review the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) relating to the type of change you are making to ensure all of the necessary steps have been taken. - * Whether or not the branch has been rebased will **not** impact prioritization, but doing so is always a welcome surprise. \ No newline at end of file + * Please review the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) relating to the type of change you are making to ensure all of the necessary steps have been taken. + * Whether or not the branch has been rebased will **not** impact prioritization, but doing so is always a welcome surprise. \ No newline at end of file From 584eac237cb4143bbc2c3edd07006c045f6496a3 Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Wed, 7 Sep 2022 17:38:07 -0500 Subject: [PATCH 16/19] More YAML sacrifices --- .github/workflows/community-comment.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/community-comment.yml b/.github/workflows/community-comment.yml index 3c8b7ed6315..61e554a7513 100644 --- a/.github/workflows/community-comment.yml +++ b/.github/workflows/community-comment.yml @@ -19,16 +19,16 @@ jobs: # Community Note **Voting for Prioritization** - + * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original post to help the community and maintainers prioritize this request. * Please see our [prioritization guide](https://hashicorp.github.io/terraform-provider-aws/prioritization/) for information on how we prioritize. * Please **do not** leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request. - + **Volunteering to Work on This Issue** - + * If you are interested in working on this issue, please leave a comment. * If this would be your first contribution, please review the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/). - + - name: Add community note to new Pull Requests uses: peter-evans/create-or-update-comment@v1 if: github.event_name == 'pull_request_target' @@ -38,7 +38,7 @@ jobs: # Community Note **Voting for Prioritization** - + * Please vote on this pull request by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original post to help the community and maintainers prioritize this pull request. * Please see our [prioritization guide](https://hashicorp.github.io/terraform-provider-aws/prioritization/) for information on how we prioritize. * Please **do not** leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request. @@ -46,4 +46,4 @@ jobs: **For Submitters** * Please review the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) relating to the type of change you are making to ensure all of the necessary steps have been taken. - * Whether or not the branch has been rebased will **not** impact prioritization, but doing so is always a welcome surprise. \ No newline at end of file + * Whether or not the branch has been rebased will **not** impact prioritization, but doing so is always a welcome surprise. From 32de0d58cabfd2d492fc988c3733a08ab6d745dc Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Wed, 7 Sep 2022 17:39:59 -0500 Subject: [PATCH 17/19] YAML fixes on issues workflow --- .github/workflows/issues.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/issues.yml b/.github/workflows/issues.yml index 2289e917b87..d8897c0557e 100644 --- a/.github/workflows/issues.yml +++ b/.github/workflows/issues.yml @@ -11,9 +11,9 @@ jobs: AddLabelsForIssueTriage: runs-on: ubuntu-latest steps: - - name: Apply Issue Triage Labels - uses: github/issue-labeler@v2.5 - with: - repo-token: "${{ secrets.GITHUB_TOKEN }}" - configuration-path: .github/labeler-issue-triage.yml - enable-versioned-regex: 0 \ No newline at end of file + - name: Apply Issue Triage Labels + uses: github/issue-labeler@v2.5 + with: + repo-token: "${{ secrets.GITHUB_TOKEN }}" + configuration-path: .github/labeler-issue-triage.yml + enable-versioned-regex: 0 From 07a21195d4f7b14e13b37a1872b3478a696770e1 Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Wed, 7 Sep 2022 17:42:15 -0500 Subject: [PATCH 18/19] YAML fixes for config.yml --- .github/ISSUE_TEMPLATE/config.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 2212c21eb50..b9239eb1378 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,15 +3,15 @@ contact_links: - name: Terraform AWS Provider Questions url: https://discuss.hashicorp.com/c/terraform-providers/tf-aws about: GitHub issues in this repository are only intended for bug reports and feature requests. Other issues will be closed. Please ask and answer questions through the Terraform AWS Provider Community Forum. - + - name: Terraform Core Bug Reports and Feature Requests url: https://github.com/hashicorp/terraform/issues/new/choose about: Terraform Core, which handles the Terraform configuration language, CLI commands, and resource dependency graph, has its own codebase. Bug reports and feature requests for those pieces of functionality should be directed to that repository. - + - name: Terraform Language or Workflow Questions url: https://discuss.hashicorp.com/c/terraform-core about: Please ask and answer language or workflow related questions through the Terraform Core Community Forum. - + - name: Terraform AWS Provider Roadmap url: https://github.com/hashicorp/terraform-provider-aws/blob/main/ROADMAP.md - about: View the Roadmap for the upcoming work planned on the AWS provider. \ No newline at end of file + about: View the Roadmap for the upcoming work planned on the AWS provider. From 729d537684a74e22892ffc95544d5554e454497c Mon Sep 17 00:00:00 2001 From: Justin Retzolk <44710313+justinretzolk@users.noreply.github.com> Date: Wed, 7 Sep 2022 17:52:49 -0500 Subject: [PATCH 19/19] Fix all YAML lint errors --- .github/ISSUE_TEMPLATE/00_bug_report.yml | 30 ++++++++++----------- .github/ISSUE_TEMPLATE/01_documentation.yml | 6 ++--- .github/ISSUE_TEMPLATE/02_enhancement.yml | 12 ++++----- .github/ISSUE_TEMPLATE/03_new_resource.yml | 12 ++++----- .github/ISSUE_TEMPLATE/04_repository.yml | 4 +-- .github/ISSUE_TEMPLATE/05_other.yml | 10 +++---- 6 files changed, 37 insertions(+), 37 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/00_bug_report.yml b/.github/ISSUE_TEMPLATE/00_bug_report.yml index a584d686845..63d3bfbf00c 100644 --- a/.github/ISSUE_TEMPLATE/00_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/00_bug_report.yml @@ -62,7 +62,7 @@ body: placeholder: "* aws_xxx" validations: required: false - + - type: textarea id: expected attributes: @@ -70,7 +70,7 @@ body: description: What should have happened? validations: required: true - + - type: textarea id: actual attributes: @@ -78,24 +78,24 @@ body: description: What actually happened? validations: required: true - + - type: textarea id: log_snippet attributes: label: Relevant Error/Panic Output Snippet - description: | + description: | If applicable, provide a relevant snippet from the error or panic output. This will be rendered as `shell`, so there is no need to add a [code fence](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks). render: shell validations: required: false - + - type: markdown attributes: value: | # Configuration and Logging - Here, we ask that you provide the Terraform configuration and, when possible, the debug logs. For configurations or logs of more than just a few lines, it's preferred to either share a Gist link or zip the files and upload them. - + Here, we ask that you provide the Terraform configuration and, when possible, the debug logs. For configurations or logs of more than just a few lines, it's preferred to either share a Gist link or zip the files and upload them. + Terraform configurations or debug logs under 25MB may be [attached directly in the field](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files). Files larger than this should be uploaded to a file hosting service and a link shared. For your security you can also encrypt the files using our [GPG public key](https://keybase.io/hashicorp). @@ -108,7 +108,7 @@ body: label: Terraform Configuration Files description: | Please paste, upload, or link to a file or Gist containing all Terraform configurations required to reproduce the bug. See note above for additional information on file size restrictions and encrypting. - + Bug reports without a functional reproduction may be closed without investigation. validations: required: true @@ -120,18 +120,18 @@ body: description: Please list the steps required to reproduce the issue. validations: required: true - + - type: textarea id: debug_logs attributes: label: Debug Output description: | If possible, please paste, upload, or link to a file or Gist containing debug logs. See note above for additional information on file size restrictions and encrypting. - + To obtain the debug output, see the [Terraform documentation on debugging](https://www.terraform.io/docs/internals/debugging.html). validations: required: false - + - type: textarea id: panic_logs attributes: @@ -139,7 +139,7 @@ body: description: If Terraform produced a panic, please paste, upload, or link to a file or Gist containing the output of the `crash.log`. validations: required: false - + - type: markdown attributes: value: | @@ -153,7 +153,7 @@ body: description: Are there anything atypical about your configuration or environment that we should know about? validations: required: false - + - type: textarea id: references attributes: @@ -169,10 +169,10 @@ body: id: will_contribute attributes: label: Would you like to implement a fix? - description: | + description: | If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. options: - "No" - "Yes" validations: - required: false \ No newline at end of file + required: false diff --git a/.github/ISSUE_TEMPLATE/01_documentation.yml b/.github/ISSUE_TEMPLATE/01_documentation.yml index cbbd6065257..a999274a10c 100644 --- a/.github/ISSUE_TEMPLATE/01_documentation.yml +++ b/.github/ISSUE_TEMPLATE/01_documentation.yml @@ -8,7 +8,7 @@ body: value: | # Thank you for raising a documentation issue! - This form is meant to alert the maintainers to an issue with the provider documentation found on the [Terraform Registry](https://registry.terraform.io/providers/hashicorp/aws/latest) (such as resource and data source documentation, guides and examples), as well as the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/). + This form is meant to alert the maintainers to an issue with the provider documentation found on the [Terraform Registry](https://registry.terraform.io/providers/hashicorp/aws/latest) (such as resource and data source documentation, guides and examples), as well as the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/). Documentation edits are generally a bit less involved, so are often a great entrypoint if you've ever been interested in [contributing](https://hashicorp.github.io/terraform-provider-aws/documentation-changes/)! @@ -43,10 +43,10 @@ body: id: will_contribute attributes: label: Would you like to implement a fix? - description: | + description: | If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. options: - "No" - "Yes" validations: - required: false \ No newline at end of file + required: false diff --git a/.github/ISSUE_TEMPLATE/02_enhancement.yml b/.github/ISSUE_TEMPLATE/02_enhancement.yml index 16e5d06496c..2abdf6cfcab 100644 --- a/.github/ISSUE_TEMPLATE/02_enhancement.yml +++ b/.github/ISSUE_TEMPLATE/02_enhancement.yml @@ -9,7 +9,7 @@ body: # Thank you for opening an enhancement request! This form is intended as a way to request additional functionality for existing resources, data sources, or the provider itself. This may include requests such as adding additional arguments or attributes enabled by upstream API changes, additional validation for arguments, etc. - + If the absense of the requested feature is causing unexpected behavior in the provider, the "Report a Bug" form should be used. For entirely new resources, data sources, or services, please use the Request a "New Resource, Data Source, or AWS Service" form. - type: textarea @@ -19,7 +19,7 @@ body: description: Please leave a brief description of the requested change. validations: required: true - + - type: textarea id: affected attributes: @@ -27,7 +27,7 @@ body: placeholder: "* aws_xxx_yyy" validations: required: false - + - type: textarea id: tf_config attributes: @@ -39,7 +39,7 @@ body: render: terraform validations: required: false - + - type: textarea id: references attributes: @@ -55,10 +55,10 @@ body: id: will_contribute attributes: label: Would you like to implement a fix? - description: | + description: | If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. options: - "No" - "Yes" validations: - required: false \ No newline at end of file + required: false diff --git a/.github/ISSUE_TEMPLATE/03_new_resource.yml b/.github/ISSUE_TEMPLATE/03_new_resource.yml index cd10fdbd5a8..d009e76fbb1 100644 --- a/.github/ISSUE_TEMPLATE/03_new_resource.yml +++ b/.github/ISSUE_TEMPLATE/03_new_resource.yml @@ -25,14 +25,14 @@ body: description: Please leave a brief description of what you're requesting. validations: required: true - + - type: textarea id: resources attributes: label: Requested Resource(s) and/or Data Source(s) description: | - Please list any new resource(s) and/or data source(s). The naming format is `aws__`, e.g., `aws_lambda_function`. - + Please list any new resource(s) and/or data source(s). The naming format is `aws__`, e.g., `aws_lambda_function`. + A best guess is helpful, even if you're unsure of exactly what the end result will look like. This helps maintainers and the community better understand how you (someone who is in need of this request) envisions it. placeholder: "* aws_xxx_yyy" validations: @@ -49,7 +49,7 @@ body: render: terraform validations: required: false - + - type: textarea id: references attributes: @@ -65,10 +65,10 @@ body: id: will_contribute attributes: label: Would you like to implement a fix? - description: | + description: | If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. options: - "No" - "Yes" validations: - required: false \ No newline at end of file + required: false diff --git a/.github/ISSUE_TEMPLATE/04_repository.yml b/.github/ISSUE_TEMPLATE/04_repository.yml index 2137fe988f0..9b11f218b4d 100644 --- a/.github/ISSUE_TEMPLATE/04_repository.yml +++ b/.github/ISSUE_TEMPLATE/04_repository.yml @@ -28,12 +28,12 @@ body: [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) validations: required: false - + - type: dropdown id: will_contribute attributes: label: Would you like to implement a fix? - description: | + description: | If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. options: - "No" diff --git a/.github/ISSUE_TEMPLATE/05_other.yml b/.github/ISSUE_TEMPLATE/05_other.yml index 571a29bddce..0450f756016 100644 --- a/.github/ISSUE_TEMPLATE/05_other.yml +++ b/.github/ISSUE_TEMPLATE/05_other.yml @@ -4,7 +4,7 @@ labels: ["needs-triage"] body: - type: markdown attributes: - value: | + value: | # Thank you for raising an issue! This form is meant as a catch-all for issues that do not fit into one of the other existing forms: @@ -24,7 +24,7 @@ body: description: Please leave a detailed description of the issue. validations: required: true - + - type: textarea id: references attributes: @@ -35,15 +35,15 @@ body: [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) validations: required: false - + - type: dropdown id: will_contribute attributes: label: Would you like to implement a fix? - description: | + description: | If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. options: - "No" - "Yes" validations: - required: false \ No newline at end of file + required: false