From 64ab76d82662b8e21679e887d5b3df8d15cfaf3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Cie=C5=9Blak?= Date: Tue, 30 Apr 2024 11:55:54 +0200 Subject: [PATCH] chore: Adjust issue templates (#2748) ## Questions - Q: Are existing fields fine? - is it too similar to the bug one? - Q: Is field validation correct? - although some forms are the same as in the bug one, they lack validation, because it depends on the type of issue as they can be *general*. - Q: Do we add deprecated object types or stick to the non-deprecated ones? - right now I only specified non-deprecated ones ## Changes - **New issue template for general usage questions** - **Adjusted templates** - Bug - Docs - Feature - **Added top-level `config.yml` to show additional links and disable the possibility of creating blank issues.** ## Possible improvements - Right now, it's not possible to add conditional labeling based on e.g. chosen category from the dropdown. Afaik there's already an existing solution based on gh actions: https://github.com/marketplace/actions/advanced-issue-labeler. ## TODO - Add missing category and object labels in the repository - Link FAQ in a few places once it will be available --- .github/ISSUE_TEMPLATE/01-bug.yml | 264 ++++++++++++++++++ .github/ISSUE_TEMPLATE/02-general-usage.yml | 254 +++++++++++++++++ .github/ISSUE_TEMPLATE/03-documentation.yml | 154 ++++++++++ .github/ISSUE_TEMPLATE/04-feature-request.yml | 196 +++++++++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 77 ----- .github/ISSUE_TEMPLATE/config.yml | 14 + .github/ISSUE_TEMPLATE/documentation.yml | 52 ---- .github/ISSUE_TEMPLATE/feature_request.yml | 52 ---- 8 files changed, 882 insertions(+), 181 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/01-bug.yml create mode 100644 .github/ISSUE_TEMPLATE/02-general-usage.yml create mode 100644 .github/ISSUE_TEMPLATE/03-documentation.yml create mode 100644 .github/ISSUE_TEMPLATE/04-feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/documentation.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/01-bug.yml b/.github/ISSUE_TEMPLATE/01-bug.yml new file mode 100644 index 0000000000..e2e83e7af9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug.yml @@ -0,0 +1,264 @@ +name: Bug +description: Something is incorrect or not working as expected. +title: [Bug]: +labels: ["bug"] +body: + - type: markdown + attributes: + # TODO(SNOW-1003360): Link doc how to submit issues and FAQ + # - [Frequently Asked Questions](https://github.com/Snowflake-Labs/) + value: | + # Thank you for raising a bug report! + + Before submitting, we ask that you first search existing issues (also the closed ones) 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. + + If you would like to contribute to the project, please let us know and refer to the [contribution guide](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/CONTRIBUTING.md) for tips on getting started. + + Here's a list of useful links that may help you with your issue: + - [Migration Guide](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md) - when introducing breaking changes, we note them in the migration guide and describe how to upgrade to the next version. If you recently upgraded the provider version, please check if you applied all the needed changes. + + - type: markdown + attributes: + value: | + # Terraform CLI and Snowflake Provider Versions + + Please run `terraform version` to show Terraform CLI and Snowflake Provider versions. + If you are not running the latest version of either CLI or the Provider, please consider upgrading as your issue could be already resolved. + + - id: terraform-cli-version + type: input + attributes: + label: Terraform CLI Version + description: The semantic version of Terraform CLI + placeholder: "x.y.z" + validations: + required: true + + - id: terraform-provider-version + type: input + attributes: + label: Terraform Provider Version + description: The semantic version of Terraform Provider + placeholder: "x.y.z" + validations: + required: true + + - type: markdown + attributes: + value: | + # Issue Description + + In the following fields, please provide as much information as possible to reduce the time of us providing help. + Remember to put the configuration and logs in the form below for additional context. + + - id: terraform-configuration + type: textarea + attributes: + label: Terraform Configuration + description: Please copy and paste any relevant Terraform configuration. This will be automatically formatted into code, so no need for backticks. + render: terraform + validations: + required: true + + - id: category + type: dropdown + attributes: + label: Category + description: | + Choose an appropriate category for the issue: + - **resource** - an issue with resource(s). + - **grants** - an issue with resource(s) / data source(s) dedicated for access management (granting privileges, roles, etc.). + - **data_source** - an issue with data source(s). + - **import** - difficulties when importing resource(s) / data source(s) with the **terraform import** command. + - **sdk** - an issue with the underlying SDK (could be deduced by looking into stack traces in logs). + - **identifiers** - an issue with resource(s) / data source(s) having problems with accepting particular form of identifier. + - **provider_config** - an issue with the provider configuration. + - **other** - for any other type of issue in the provider. + options: + - category:resource + - category:data_source + - category:import + - category:sdk + - category:identifiers + - category:provider_config + - category:grants + - category:other + validations: + required: true + + - id: object_type + type: dropdown + attributes: + label: Object type(s) + description: Choose object type(s) causing the issue (if any). + multiple: true + options: + - resource:account + - resource:account_parameter + - resource:account_password_policy + - resource:alert + - resource:api_integration + - resource:database + - resource:database_role + - resource:dynamic_table + - resource:email_notification_integration + - resource:external_function + - resource:external_oauth_integration + - resource:external_table + - resource:failover_group + - resource:file_format + - resource:function + - resource:grant_account_role + - resource:grant_database_role + - resource:grant_ownership + - resource:grant_privileges_to_account_role + - resource:grant_privileges_to_database_role + - resource:grant_privileges_to_share + - resource:managed_account + - resource:masking_policy + - resource:materialized_view + - resource:network_policy + - resource:network_policy_attachment + - resource:notification_integration + - resource:oauth_integration + - resource:object_parameter + - resource:password_policy + - resource:pipe + - resource:procedure + - resource:resource_monitor + - resource:role + - resource:row_access_policy + - resource:saml_integration + - resource:schema + - resource:scim_integration + - resource:sequence + - resource:session_parameter + - resource:share + - resource:stage + - resource:storage_integration + - resource:stream + - resource:table + - resource:table_column_masking_policy_application + - resource:table_constraint + - resource:tag + - resource:tag_association + - resource:tag_masking_policy_association + - resource:task + - resource:unsafe_execute + - resource:user + - resource:user_password_policy_attachment + - resource:user_public_keys + - resource:view + - resource:warehouse + - data_source:accounts + - data_source:alerts + - data_source:current_account + - data_source:current_role + - data_source:database + - data_source:database_roles + - data_source:databases + - data_source:dynamic_tables + - data_source:external_functions + - data_source:external_tables + - data_source:failover_groups + - data_source:file_formats + - data_source:functions + - data_source:grants + - data_source:masking_policies + - data_source:materialized_views + - data_source:parameters + - data_source:pipes + - data_source:procedures + - data_source:resource_monitors + - data_source:roles + - data_source:row_access_policies + - data_source:schemas + - data_source:sequences + - data_source:shares + - data_source:stages + - data_source:storage_integrations + - data_source:streams + - data_source:system_generate_scim_access_token + - data_source:system_get_aws_sns_iam_policy + - data_source:system_get_privatelink_config + - data_source:system_get_snowflake_platform_info + - data_source:tables + - data_source:tasks + - data_source:users + - data_source:views + - data_source:warehouses + + - id: expected-behavior + type: textarea + attributes: + label: Expected Behavior + description: What did you expect to happen? + validations: + required: true + + - id: actual-behavior + type: textarea + attributes: + label: Actual Behavior + description: What actually happened? + validations: + required: true + + - id: reproduction-steps + type: textarea + attributes: + label: Steps to Reproduce + description: List of steps to reproduce the issue. + placeholder: | + For example: + 1. Copy the following configuration ... + 2. Run *terraform apply* + 3. Update field *x* in resource *y* to value *z* + 4. Run *terraform apply* + validations: + required: true + + - id: impact + type: dropdown + attributes: + label: How much impact is this issue causing? + description: | + Please choose the appropriate impact for the issue keeping in mind that: + - **High** - completely not able to use the provider or unexpected destruction of data/infrastructure. + - **Medium** - unable to upgrade provider version or an issue with potential workaround. + - **Low** - minor provider code or configuration issues. + options: + - High + - Medium + - Low + default: + 2 # Low + validations: + required: true + + - id: logs + type: input + attributes: + label: Logs + description: | + Please provide a link to a [GitHub Gist](https://gist.github.com) containing log output. [Terraform Debugging Documentation](https://www.terraform.io/internals/debugging) + + Here's a list of environment variables you can set for logging additional information: + - *TF_LOG=DEBUG* - this one is a must-have as it's printing executed SQLs which helps us to see what is happening underneath. + - *SF_TF_GOSNOWFLAKE_LOG_LEVEL=debug* - if you feel the problem may be connected with the Snowflake driver, please set this one for additional driver logs. + placeholder: https://gist.github.com/example/12345678 + + - id: additional-information + type: textarea + attributes: + label: Additional Information + description: Are there any additional details about your environment, workflow, or recent changes that might be relevant? Have you discovered a workaround? Are there links to other related issues? + + - id: will-contribute + type: checkboxes + 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). + options: + - label: Yeah, I'll take it 😎 diff --git a/.github/ISSUE_TEMPLATE/02-general-usage.yml b/.github/ISSUE_TEMPLATE/02-general-usage.yml new file mode 100644 index 0000000000..fe47a93482 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-general-usage.yml @@ -0,0 +1,254 @@ +name: General Usage +description: General help or questions about the usage of provider. +title: [General Usage]: +labels: ["general-usage"] +body: + - type: markdown + attributes: + # TODO(SNOW-1003360): Link doc how to submit issues and FAQ + # - [Frequently Asked Questions](https://github.com/Snowflake-Labs/) + value: | + # Thank you for raising an issue! + + This form is meant to be used as a way to report issues connected strictly to the provider usage. + Here are a few examples of general usage issues: + - Configurations presented as examples are not working as expected. + - Help with setting up provider configuration for two different accounts. + - Poor ergonomics of usage between two closely related resources like stage and external table. + + Before submitting, we ask that you first search existing issues (also the closed ones) 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. + + Here's a list of useful links that may help you with your issue: + - [Migration Guide](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md) - when introducing breaking changes, we note them in the migration guide and describe how to upgrade to the next version. If you recently upgraded the provider version, please check if you applied all the needed changes. + + - type: markdown + attributes: + value: | + # Terraform CLI and Snowflake Provider Versions + + Please run `terraform version` to show Terraform CLI and Snowflake Provider versions. + If you are not running the latest version of either CLI or the Provider, please consider upgrading as your issue could be already resolved. + + - id: terraform-cli-version + type: input + attributes: + label: Terraform CLI Version + description: The semantic version of Terraform CLI + placeholder: "x.y.z" + + - id: terraform-provider-version + type: input + attributes: + label: Terraform Provider Version + description: The semantic version of Terraform Provider + placeholder: "x.y.z" + + - type: markdown + attributes: + value: | + # Issue Description + + In the following fields, please provide as much information as possible to reduce the time of us providing help. + Remember to put the configuration and logs in the form below for additional context if you feel they will be relevant in this case. + + - id: issue-description + type: textarea + attributes: + label: Terraform Configuration + description: Please copy and paste any relevant Terraform configuration. This will be automatically formatted into code, so no need for backticks. + render: terraform + + - id: category + type: dropdown + attributes: + label: Category + description: | + Choose an appropriate category for the issue: + - **resource** - an issue with resource(s) + - **grants** - an issue with resource(s) / data source(s) dedicated for access management (granting privileges, roles, etc.) + - **data_source** - an issue with data source(s) + - **import** - difficulties when importing resource(s) / data source(s) with the *terraform import* command + - **sdk** - an issue with the underlying SDK (could be deduced by looking into stack traces in logs) + - **identifiers** - an issue with resource(s) / data source(s) having problems with accepting particular form of identifier + - **provider_config** - an issue with the provider configuration + - **other** - for any other type of issue in the provider + options: + - category:resource + - category:data_source + - category:import + - category:sdk + - category:identifiers + - category:provider_config + - category:grants + - category:other + validations: + required: true + + - id: object_type + type: dropdown + attributes: + label: Object type(s) + description: Choose object type(s) causing the issue (if any). + multiple: true + options: + - resource:account + - resource:account_parameter + - resource:account_password_policy + - resource:alert + - resource:api_integration + - resource:database + - resource:database_role + - resource:dynamic_table + - resource:email_notification_integration + - resource:external_function + - resource:external_oauth_integration + - resource:external_table + - resource:failover_group + - resource:file_format + - resource:function + - resource:grant_account_role + - resource:grant_database_role + - resource:grant_ownership + - resource:grant_privileges_to_account_role + - resource:grant_privileges_to_database_role + - resource:grant_privileges_to_share + - resource:managed_account + - resource:masking_policy + - resource:materialized_view + - resource:network_policy + - resource:network_policy_attachment + - resource:notification_integration + - resource:oauth_integration + - resource:object_parameter + - resource:password_policy + - resource:pipe + - resource:procedure + - resource:resource_monitor + - resource:role + - resource:row_access_policy + - resource:saml_integration + - resource:schema + - resource:scim_integration + - resource:sequence + - resource:session_parameter + - resource:share + - resource:stage + - resource:storage_integration + - resource:stream + - resource:table + - resource:table_column_masking_policy_application + - resource:table_constraint + - resource:tag + - resource:tag_association + - resource:tag_masking_policy_association + - resource:task + - resource:unsafe_execute + - resource:user + - resource:user_password_policy_attachment + - resource:user_public_keys + - resource:view + - resource:warehouse + - data_source:accounts + - data_source:alerts + - data_source:current_account + - data_source:current_role + - data_source:database + - data_source:database_roles + - data_source:databases + - data_source:dynamic_tables + - data_source:external_functions + - data_source:external_tables + - data_source:failover_groups + - data_source:file_formats + - data_source:functions + - data_source:grants + - data_source:masking_policies + - data_source:materialized_views + - data_source:parameters + - data_source:pipes + - data_source:procedures + - data_source:resource_monitors + - data_source:roles + - data_source:row_access_policies + - data_source:schemas + - data_source:sequences + - data_source:shares + - data_source:stages + - data_source:storage_integrations + - data_source:streams + - data_source:system_generate_scim_access_token + - data_source:system_get_aws_sns_iam_policy + - data_source:system_get_privatelink_config + - data_source:system_get_snowflake_platform_info + - data_source:tables + - data_source:tasks + - data_source:users + - data_source:views + - data_source:warehouses + + - id: expected-behavior + type: textarea + attributes: + label: Expected Behavior + description: What did you expect to happen? + validations: + required: true + + - id: actual-behavior + type: textarea + attributes: + label: Actual Behavior + description: What actually happened? + validations: + required: true + + - id: reproduction-steps + type: textarea + attributes: + label: Steps to Reproduce + description: List of steps to reproduce the issue. + placeholder: | + For example: + 1. Copy the following configuration ... + 2. Run *terraform apply* + 3. Update field *x* in resource *y* to value *z* + 4. Run *terraform apply* + validations: + required: true + + - id: impact + type: dropdown + attributes: + label: How much impact is this issue causing? + description: | + Please choose the appropriate impact for the issue keeping in mind that: + - **High** - completely not able to use the provider or unexpected destruction of data/infrastructure. + - **Medium** - unable to upgrade provider version or an issue with potential workaround. + - **Low** - minor provider code or configuration issues. + options: + - High + - Medium + - Low + default: + 2 # Low + validations: + required: true + + - id: logs + type: input + attributes: + label: Logs + description: | + Please provide a link to a [GitHub Gist](https://gist.github.com) containing log output. [Terraform Debugging Documentation](https://www.terraform.io/internals/debugging) + + Here's a list of environment variables you can set for logging additional information: + - *TF_LOG=DEBUG* - this one is a must-have as it's printing executed SQLs which helps us to see what is happening underneath. + - *SF_TF_GOSNOWFLAKE_LOG_LEVEL=debug* - if you feel the problem may be connected with the Snowflake driver, please set this one for additional driver logs. + placeholder: https://gist.github.com/example/12345678 + + - id: additional-information + type: textarea + attributes: + label: Additional Information + description: Are there any additional details about your environment, workflow, or recent changes that might be relevant? Have you discovered a workaround? Are there links to other related issues? diff --git a/.github/ISSUE_TEMPLATE/03-documentation.yml b/.github/ISSUE_TEMPLATE/03-documentation.yml new file mode 100644 index 0000000000..1f33c8a421 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-documentation.yml @@ -0,0 +1,154 @@ +name: Documentation +description: Issues or feature requests for the documentation. +title: [Docs]: +labels: ["docs"] +body: + # TODO(SNOW-1003360): Link doc how to submit issues and FAQ + - type: markdown + attributes: + value: | + # Thank you for raising a documentation issue! + + This form is meant to alert the maintainers to an issue with any of documentation connected with the provider, especially in: + - [Terraform Registry](https://registry.terraform.io/providers/hashicorp/snowflake/latest) (such as resource and data source documentation, guides and examples). + - [Project README](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/README.md). + - [Contribution Guide](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/CONTRIBUTING.md). + - [Migration Guide](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md). + + Documentation edits are generally a bit less involved, so are often a great entrypoint if you've ever been interested in contributing! + If you would like to contribute to the project, please let us know and refer to the [contribution guide](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/CONTRIBUTING.md) for tips on getting started. + + - id: object_type + type: dropdown + attributes: + label: Object type(s) + description: Choose for which object type(s) the documentation is incorrect (if any). + multiple: true + options: + - resource:account + - resource:account_parameter + - resource:account_password_policy + - resource:alert + - resource:api_integration + - resource:database + - resource:database_role + - resource:dynamic_table + - resource:email_notification_integration + - resource:external_function + - resource:external_oauth_integration + - resource:external_table + - resource:failover_group + - resource:file_format + - resource:function + - resource:grant_account_role + - resource:grant_database_role + - resource:grant_ownership + - resource:grant_privileges_to_account_role + - resource:grant_privileges_to_database_role + - resource:grant_privileges_to_share + - resource:managed_account + - resource:masking_policy + - resource:materialized_view + - resource:network_policy + - resource:network_policy_attachment + - resource:notification_integration + - resource:oauth_integration + - resource:object_parameter + - resource:password_policy + - resource:pipe + - resource:procedure + - resource:resource_monitor + - resource:role + - resource:row_access_policy + - resource:saml_integration + - resource:schema + - resource:scim_integration + - resource:sequence + - resource:session_parameter + - resource:share + - resource:stage + - resource:storage_integration + - resource:stream + - resource:table + - resource:table_column_masking_policy_application + - resource:table_constraint + - resource:tag + - resource:tag_association + - resource:tag_masking_policy_association + - resource:task + - resource:unsafe_execute + - resource:user + - resource:user_password_policy_attachment + - resource:user_public_keys + - resource:view + - resource:warehouse + - data_source:accounts + - data_source:alerts + - data_source:current_account + - data_source:current_role + - data_source:database + - data_source:database_roles + - data_source:databases + - data_source:dynamic_tables + - data_source:external_functions + - data_source:external_tables + - data_source:failover_groups + - data_source:file_formats + - data_source:functions + - data_source:grants + - data_source:masking_policies + - data_source:materialized_views + - data_source:parameters + - data_source:pipes + - data_source:procedures + - data_source:resource_monitors + - data_source:roles + - data_source:row_access_policies + - data_source:schemas + - data_source:sequences + - data_source:shares + - data_source:stages + - data_source:storage_integrations + - data_source:streams + - data_source:system_generate_scim_access_token + - data_source:system_get_aws_sns_iam_policy + - data_source:system_get_privatelink_config + - data_source:system_get_snowflake_platform_info + - data_source:tables + - data_source:tasks + - data_source:users + - data_source:views + - data_source:warehouses + + - id: affected-page-link + type: input + attributes: + label: Documentation Link + description: Please provide a link to the page with invalid documentation. + validations: + required: true + + - id: description + type: textarea + attributes: + label: Description + description: Please leave a brief description of the issue in the documentation. + validations: + required: true + + - id: references + type: textarea + attributes: + label: References + description: | + Where possible, please supply links to Snowflake SQL 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) + + - id: will-contribute + type: checkboxes + 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). + options: + - label: Yeah, I'll take it 😎 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/04-feature-request.yml b/.github/ISSUE_TEMPLATE/04-feature-request.yml new file mode 100644 index 0000000000..42072786fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-feature-request.yml @@ -0,0 +1,196 @@ +name: Feature Request +description: Something is missing or could be improved. +title: [Feature]: +labels: ["feature-request"] +body: + # TODO(SNOW-1003360): Link doc how to submit issues and FAQ + - type: markdown + attributes: + value: | + # Thank you for raising a feature request! + + Before submitting, we ask that you first search existing issues (also the closed ones) to see if someone else may have submitted the same issue. + This helps to keep all relevant information in one place, including any potential workarounds. + + If you are not running the latest version of either CLI or the Provider, please consider upgrading as the feature could be already implemented. + + If you would like to contribute to the project, please let us know and refer to the [contribution guide](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/CONTRIBUTING.md) for tips on getting started. + + Here's a list of useful links that may answer your question: + - [Provider Roadmap](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/ROADMAP.md) + + - id: use-case + type: textarea + attributes: + label: Use Cases or Problem Statement + description: What use cases or problems are you trying to solve? + placeholder: Description of use cases or problems. + validations: + required: true + + - id: category + type: dropdown + attributes: + label: Category + description: | + Choose an appropriate category for the issue: + - **resource** - a missing feature in resource(s) + - **grants** - a missing feature in resource(s) / data source(s) dedicated for access management (granting privileges, roles, etc.) + - **data_source** - a missing feature in data source(s) + - **import** - missing functionality in resource(s) / data source(s) when importing with *terraform import* command + - **sdk** - an issue with the underlying SDK + - **identifiers** - an unsupported type of identifier + - **provider_config** - a missing functionality in the provider configuration + - **other** - for any other missing functionality in the provider + options: + - category:resource + - category:data_source + - category:import + - category:sdk + - category:identifiers + - category:provider_config + - category:grants + - category:other + validations: + required: true + + - id: object_type + type: dropdown + attributes: + label: Object type(s) + description: Choose object type(s) affected by the proposal (if any). + multiple: true + options: + - resource:account + - resource:account_parameter + - resource:account_password_policy + - resource:alert + - resource:api_integration + - resource:database + - resource:database_role + - resource:dynamic_table + - resource:email_notification_integration + - resource:external_function + - resource:external_oauth_integration + - resource:external_table + - resource:failover_group + - resource:file_format + - resource:function + - resource:grant_account_role + - resource:grant_database_role + - resource:grant_ownership + - resource:grant_privileges_to_account_role + - resource:grant_privileges_to_database_role + - resource:grant_privileges_to_share + - resource:managed_account + - resource:masking_policy + - resource:materialized_view + - resource:network_policy + - resource:network_policy_attachment + - resource:notification_integration + - resource:oauth_integration + - resource:object_parameter + - resource:password_policy + - resource:pipe + - resource:procedure + - resource:resource_monitor + - resource:role + - resource:row_access_policy + - resource:saml_integration + - resource:schema + - resource:scim_integration + - resource:sequence + - resource:session_parameter + - resource:share + - resource:stage + - resource:storage_integration + - resource:stream + - resource:table + - resource:table_column_masking_policy_application + - resource:table_constraint + - resource:tag + - resource:tag_association + - resource:tag_masking_policy_association + - resource:task + - resource:unsafe_execute + - resource:user + - resource:user_password_policy_attachment + - resource:user_public_keys + - resource:view + - resource:warehouse + - data_source:accounts + - data_source:alerts + - data_source:current_account + - data_source:current_role + - data_source:database + - data_source:database_roles + - data_source:databases + - data_source:dynamic_tables + - data_source:external_functions + - data_source:external_tables + - data_source:failover_groups + - data_source:file_formats + - data_source:functions + - data_source:grants + - data_source:masking_policies + - data_source:materialized_views + - data_source:parameters + - data_source:pipes + - data_source:procedures + - data_source:resource_monitors + - data_source:roles + - data_source:row_access_policies + - data_source:schemas + - data_source:sequences + - data_source:shares + - data_source:stages + - data_source:storage_integrations + - data_source:streams + - data_source:system_generate_scim_access_token + - data_source:system_get_aws_sns_iam_policy + - data_source:system_get_privatelink_config + - data_source:system_get_snowflake_platform_info + - data_source:tables + - data_source:tasks + - data_source:users + - data_source:views + - data_source:warehouses + + - id: proposal + type: textarea + attributes: + label: Proposal + description: What solutions would you prefer? + placeholder: Description of proposed solutions. + + - id: impact + type: dropdown + attributes: + label: How much impact is this issue causing? + description: | + Please choose the appropriate impact for the issue keeping in mind that: + - **High** - completely not able to use the provider or unexpected destruction of data/infrastructure. + - **Medium** - unable to upgrade provider version or an issue with potential workaround. + - **Low** - minor provider code or configuration issues. + options: + - High + - Medium + - Low + default: + 2 # Low + validations: + required: true + + - id: additional-information + type: textarea + attributes: + label: Additional Information + description: Are there any additional details about new feature that may be relevant? + + - id: will-contribute + type: checkboxes + attributes: + label: Would you like to implement a fix? + description: If you plan to implement the feature, check this box to let the maintainers and community know (you can update this later if you change your mind). + options: + - label: Yeah, I'll take it 😎 diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index a677910fd8..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,77 +0,0 @@ -name: Bug Report -description: Something is incorrect or not working as expected. -labels: ["bug"] -body: - - type: markdown - attributes: - value: | - Thank you for taking the time to fill out this bug report! Please note that this issue tracker is only used for bug reports and feature requests. Other issues will be closed. - - If you have a configuration, workflow, or other question, please go back to the issue chooser and select one of the question links. - - type: textarea - id: versions - attributes: - label: Terraform CLI and Provider Versions - description: What versions of Terraform CLI and the provider? - placeholder: Output of `terraform version` from configuration directory - validations: - required: true - - type: textarea - id: terraform-configuration - attributes: - label: Terraform Configuration - description: Please copy and paste any relevant Terraform configuration. This will be automatically formatted into code, so no need for backticks. - render: terraform - validations: - required: true - - type: textarea - id: expected-behavior - attributes: - label: Expected Behavior - description: What did you expect to happen? - placeholder: Description of what should have happened. - validations: - required: true - - type: textarea - id: actual-behavior - attributes: - label: Actual Behavior - description: What actually happened? - placeholder: Description of what actually happened. - validations: - required: true - - type: textarea - id: reproduction-steps - attributes: - label: Steps to Reproduce - description: List of steps to reproduce the issue. - value: | - 1. `terraform apply` - validations: - required: true - - type: dropdown - id: impact - attributes: - label: How much impact is this issue causing? - description: High represents completely not able to use the provider or unexpected destruction of data/infrastructure. Medium represents unable to upgrade provider version or an issue with potential workaround. Low represents minor provider code, configuration, or documentation issues. - options: - - High - - Medium - - Low - validations: - required: true - - type: input - id: logs - attributes: - label: Logs - description: Please provide a link to a [GitHub Gist](https://gist.github.com) containing TRACE log output. [Terraform Debugging Documentation](https://www.terraform.io/internals/debugging) - placeholder: https://gist.github.com/example/12345678 - validations: - required: false - - type: textarea - id: additional-information - attributes: - label: Additional Information - description: Are there any additional details about your environment, workflow, or recent changes that might be relevant? Have you discovered a workaround? Are there links to other related issues? - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..b5616ef94b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false # turn off the possibility to create a new issue without using one of the existing templates +contact_links: + - name: Provider Roadmap + url: https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/ROADMAP.md + about: Roadmap for the upcoming work planned on the provider. + + - name: Migration Guide + url: https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md + about: Migration Guide that presents breaking changes between the versions with actions needed during upgrading. + +# TODO(SNOW-1003360): Link FAQ +#- name: Frequently Asked Questions / Common issues with solutions +# url: https://github.com/Snowflake-Labs/terraform-provider-snowflake/ +# about: A list of common provider question and issues with workarounds or solutions for them. diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml deleted file mode 100644 index ae2c2d3e6f..0000000000 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ /dev/null @@ -1,52 +0,0 @@ -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"] -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/snowflake/latest) (such as resource and data source documentation, guides and examples), as well as the [contribution guide](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/CONTRIBUTING.md). - - Documentation edits are generally a bit less involved, so are often a great entrypoint if you've ever been interested in contributing! - - - 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 Snowflake SQL 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://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/CONTRIBUTING.md) for tips on getting started. - options: - - "No" - - "Yes" - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml deleted file mode 100644 index 11cdb5d72c..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,52 +0,0 @@ -name: Feature Request -description: Something is missing or could be improved. -labels: ["feature-request"] -body: - - type: markdown - attributes: - value: | - Thank you for taking the time to fill out this feature request! Please note that this issue tracker is only used for bug reports and feature requests. Other issues will be closed. - - If you have a configuration, workflow, or other question, please go back to the issue chooser and select one of the question links. - - type: textarea - id: versions - attributes: - label: Terraform CLI and Provider Versions - description: What versions of Terraform CLI and the provider? - placeholder: Output of `terraform version` from configuration directory - validations: - required: true - - type: textarea - id: use-case - attributes: - label: Use Cases or Problem Statement - description: What use cases or problems are you trying to solve? - placeholder: Description of use cases or problems. - validations: - required: true - - type: textarea - id: proposal - attributes: - label: Proposal - description: What solutions would you prefer? - placeholder: Description of proposed solutions. - validations: - required: true - - type: dropdown - id: impact - attributes: - label: How much impact is this issue causing? - description: High represents completely not able to use the provider without this. Medium represents unable to solve a specific problem or understand something. Low represents minor provider code, configuration, or documentation issues. - options: - - High - - Medium - - Low - validations: - required: true - - type: textarea - id: additional-information - attributes: - label: Additional Information - description: Are there any additional details about your environment, workflow, or recent changes that might be relevant? Have you discovered a workaround? Are there links to other related issues? - validations: - required: false