resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
terraform/.github/ISSUE_TEMPLATE/bug_report.md

78 lines
2.4 KiB
Markdown
Raw Normal View History

Separate issue templates for Bugs vs. Features Here our prior existing single template becomes the "Bug report" template, and we introduce a second "Feature request" template that is more appropriate for gathering context about a feature request.
2018-08-11 03:19:42 +02:00
---
name: Bug report
about: Let us know about an unexpected error, a crash, or an incorrect behavior.
---
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
<!--
Add issue_template (#6017)
2016-04-11 17:33:06 +02:00
Hi there,
Unwrap text in issue template This plays more nicely with mobile email clients.
2016-04-11 17:47:54 +02:00
Thank you for opening an issue. Please note that we try to keep the Terraform issue tracker reserved for bug reports and feature requests. For general usage questions, please see: https://www.terraform.io/community.html.
Add issue_template (#6017)
2016-04-11 17:33:06 +02:00
Revisions to ISSUE_TEMPLATE.md This is just a few editorial tweaks to the issue template. The primary motivation here was to shorten the section about provider issues now that we're no longer in the transitional state; I suspect that this scary wall of text is dissuading people from actually reading and following the template. Otherwise, this is just some tweaks to the wording and some adjustments for the fact that we're now not expecting provider issues here.
2017-08-23 20:35:32 +02:00
If your issue relates to a specific Terraform provider, please open it in the provider's own repository. The index of providers is at https://github.com/terraform-providers .
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
-->
Revisions to ISSUE_TEMPLATE.md This is just a few editorial tweaks to the issue template. The primary motivation here was to shorten the section about provider issues now that we're no longer in the transitional state; I suspect that this scary wall of text is dissuading people from actually reading and following the template. Otherwise, this is just some tweaks to the wording and some adjustments for the fact that we're now not expecting provider issues here.
2017-08-23 20:35:32 +02:00
Add issue_template (#6017)
2016-04-11 17:33:06 +02:00
### Terraform Version
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
<!---
Run `terraform -v` to show the version, and paste the result between the ``` marks below.
If you are not running the latest version of Terraform, please try upgrading because your issue may have already been fixed.
-->
```
...
```
Add issue_template (#6017)
2016-04-11 17:33:06 +02:00
### Terraform Configuration Files
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
<!--
Paste the relevant parts of your Terraform configuration between the ``` marks below.
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.
-->
Add issue_template (#6017)
2016-04-11 17:33:06 +02:00
```hcl
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
...
Add issue_template (#6017)
2016-04-11 17:33:06 +02:00
```
### Debug Output
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
<!--
Revisions to ISSUE_TEMPLATE.md This is just a few editorial tweaks to the issue template. The primary motivation here was to shorten the section about provider issues now that we're no longer in the transitional state; I suspect that this scary wall of text is dissuading people from actually reading and following the template. Otherwise, this is just some tweaks to the wording and some adjustments for the fact that we're now not expecting provider issues here.
2017-08-23 20:35:32 +02:00
Full debug output can be obtained by running Terraform with the environment variable `TF_LOG=trace`. Please create a GitHub Gist containing the debug output. Please do _not_ paste the debug output in the issue, since debug output is long.
Debug output may contain sensitive information. Please review it before posting publicly, and if you are concerned feel free to encrypt the files using the HashiCorp security public key.
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
-->
Add issue_template (#6017)
2016-04-11 17:33:06 +02:00
Revisions to ISSUE_TEMPLATE.md This is just a few editorial tweaks to the issue template. The primary motivation here was to shorten the section about provider issues now that we're no longer in the transitional state; I suspect that this scary wall of text is dissuading people from actually reading and following the template. Otherwise, this is just some tweaks to the wording and some adjustments for the fact that we're now not expecting provider issues here.
2017-08-23 20:35:32 +02:00
### Crash Output
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
<!--
Revisions to ISSUE_TEMPLATE.md This is just a few editorial tweaks to the issue template. The primary motivation here was to shorten the section about provider issues now that we're no longer in the transitional state; I suspect that this scary wall of text is dissuading people from actually reading and following the template. Otherwise, this is just some tweaks to the wording and some adjustments for the fact that we're now not expecting provider issues here.
2017-08-23 20:35:32 +02:00
If the console output indicates that Terraform crashed, please share a link to a GitHub Gist containing the output of the `crash.log` file.
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
-->
Add issue_template (#6017)
2016-04-11 17:33:06 +02:00
### Expected Behavior
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
<!--
Add issue_template (#6017)
2016-04-11 17:33:06 +02:00
What should have happened?
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
-->
Add issue_template (#6017)
2016-04-11 17:33:06 +02:00
### Actual Behavior
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
<!--
Add issue_template (#6017)
2016-04-11 17:33:06 +02:00
What actually happened?
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
-->
Add issue_template (#6017)
2016-04-11 17:33:06 +02:00
### Steps to Reproduce
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
<!--
Revisions to ISSUE_TEMPLATE.md This is just a few editorial tweaks to the issue template. The primary motivation here was to shorten the section about provider issues now that we're no longer in the transitional state; I suspect that this scary wall of text is dissuading people from actually reading and following the template. Otherwise, this is just some tweaks to the wording and some adjustments for the fact that we're now not expecting provider issues here.
2017-08-23 20:35:32 +02:00
Please list the full steps required to reproduce the issue, for example:
1. `terraform init`
2. `terraform apply`
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
-->
Add issue_template (#6017)
2016-04-11 17:33:06 +02:00
issue template: "additional context" instead of "important factoids" As pointed out in #16987, "factoids" are not really what we're looking for here. The goal of this section is to capture additional context that isn't represented by any of our other section headings, so we'll change this to "Additional Context" to be clearer about what we want here and to avoid a confusing misuse of a quirky English word that not all readers will be familiar with.
2018-01-04 00:25:54 +01:00
### Additional Context
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
<!--
Revisions to ISSUE_TEMPLATE.md This is just a few editorial tweaks to the issue template. The primary motivation here was to shorten the section about provider issues now that we're no longer in the transitional state; I suspect that this scary wall of text is dissuading people from actually reading and following the template. Otherwise, this is just some tweaks to the wording and some adjustments for the fact that we're now not expecting provider issues here.
2017-08-23 20:35:32 +02:00
Are there anything atypical about your situation that we should know? For example: is Terraform running in a wrapper script or in a CI system? Are you passing any unusual command line options or environment variables to opt-in to non-default behavior?
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
-->
Add issue_template (#6017)
2016-04-11 17:33:06 +02:00
### References
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
<!--
Unwrap text in issue template This plays more nicely with mobile email clients.
2016-04-11 17:47:54 +02:00
Are there any other GitHub issues (open or closed) or Pull Requests that should be linked here? For example:
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
Revisions to ISSUE_TEMPLATE.md This is just a few editorial tweaks to the issue template. The primary motivation here was to shorten the section about provider issues now that we're no longer in the transitional state; I suspect that this scary wall of text is dissuading people from actually reading and following the template. Otherwise, this is just some tweaks to the wording and some adjustments for the fact that we're now not expecting provider issues here.
2017-08-23 20:35:32 +02:00
- #6017
Issue template: comment out the instruction portions By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first. The content is otherwise the same as before.
2017-11-20 18:54:09 +01:00
-->