From 2f9fa6a83c31d2ade6543cbd4a1cfb4793629a97 Mon Sep 17 00:00:00 2001 From: Marques Johansson Date: Fri, 13 Oct 2023 19:39:16 +0000 Subject: [PATCH 1/2] feat: replace issue templates with forms Signed-off-by: Marques Johansson --- .github/ISSUE_TEMPLATE/bug.md | 81 -------------------------- .github/ISSUE_TEMPLATE/bug.yml | 65 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 17 ++++++ .github/ISSUE_TEMPLATE/enhancement.md | 45 -------------- .github/ISSUE_TEMPLATE/enhancement.yml | 25 ++++++++ 5 files changed, 107 insertions(+), 126 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/enhancement.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index 1ded73743..000000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -name: Bug -about: For when something is there, but doesn't work how it should -title: '' -labels: '' -assignees: '' - ---- - - - -### 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 _me too_ comments, 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 Version - - - -### Affected Resource(s) - - - -* equinix_XXXXX - -### Terraform Configuration Files - - - -```tf -# Copy-paste your Terraform configurations here. -# -# For large Terraform configs, please use a service like Dropbox and share a link to the ZIP file. -# -# If reproducing the bug involves modifying the config file (e.g., apply a config, -# change a value, apply the config again, see the bug), then please include both: -# * the version of the config before the change, and -# * the version of the config after the change. -``` - -### Debug Output - - - -### Panic Output - - - -### Expected Behavior - - - -### Actual Behavior - - - -### Steps to Reproduce - - - -1. `terraform apply` - -### References - - - -* #0000 diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..a0cec9c45 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,65 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug"] +body: + - type: input + id: terraform-version + attributes: + label: Terraform Version + description: What version of terraform are you running? `terraform -v` + placeholder: Terraform v1.0.7 on darwin_amd64 + validations: + required: true + - type: input + id: provider-version + attributes: + label: Equinix Provider Version + description: What version of our provider are you running? + placeholder: version = "1.17.0" + validations: + required: true + - type: textarea + id: resources + attributes: + label: Effected Terraform Resources + description: Equinix resouces causing/effected by the bug + placeholder: | + equinix_metal_device + equinix_fabric_connection + - type: textarea + id: config + attributes: + label: Terraform Config Files + description: If your config files are too long for a short code snippet please use GitHub Gists + - type: textarea + id: debug + attributes: + label: Debug Output + description: To generate debug output run `terraform apply` with `TF_PROVIDER_LOG=DEBUG` and `PACKNGO_DEBUG=1`. Please use GitHub Gists if the output is long + - type: textarea + id: panic + attributes: + label: Panic Output + description: If terraform generated a panic output post a Gist with the output of crash.log + - 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: reproduce + attributes: + label: Steps to Reproduce + description: List any custom configurations and the steps to reproduce this error + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..702ff2fe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,17 @@ +blank_issues_enabled: true +contact_links: + - name: Terraform Equinix Provider Questions + url: https://community.equinix.com/t5/forums/postpage/board-id/OR + 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 Equinix 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 Equinix Provider Roadmap + url: https://github.com/equinix/terraform-provider-equinix/milestones + about: View target Milestones for the upcoming work planned on the Equinix provider. diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md deleted file mode 100644 index eccd78b0a..000000000 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: Enhancement -about: For when something (a resource, field, etc.) is missing, and should be added. -title: '' -labels: '' -assignees: '' - ---- - -### 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 "me too" comments, 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) - - - -* equinix_XXXXX - -### Potential Terraform Configuration - - - -```tf -# Propose what you think the configuration to take advantage of this feature should look like. -# We may not use it verbatim, but it's helpful in understanding your intent. -``` - -### References - - - -* #0000 diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 000000000..5397cd461 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,25 @@ +name: Enhancement +description: Request a feature +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: textarea + id: description + attributes: + label: Description + description: What would you like this feature to do in detail? + validations: + required: true + - type: textarea + id: resources + attributes: + label: New or Affected Terraform Resources + description: What resources will this create or change? + placeholder: | + equinix_metal_vlan + equinix_ibx_liquid_cooling + - type: textarea + id: config + attributes: + label: Potential Terraform Configuration + description: A small codeblock example of what the feature will look like From 76d3303437cd0ae503602ada7787f2a416731afe Mon Sep 17 00:00:00 2001 From: Marques Johansson Date: Fri, 13 Oct 2023 19:17:47 -0400 Subject: [PATCH 2/2] chore(ci): skip e2e tests on ISSUE_TEMPLATE changes Signed-off-by: Marques Johansson --- .github/workflows/acctest.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/acctest.yml b/.github/workflows/acctest.yml index a644ac1a3..4379e867a 100644 --- a/.github/workflows/acctest.yml +++ b/.github/workflows/acctest.yml @@ -14,6 +14,7 @@ on: - '**.md' - 'website/**' - 'docs/**' + - '.github/ISSUE_TEMPLATE/**' workflow_dispatch: permissions: