Skip to content

Commit f33cade

Browse files
authored
Create bug_report.yml
1 parent 6c48073 commit f33cade

File tree

1 file changed

+118
-0
lines changed

1 file changed

+118
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
name: "\U0001F41B Bug report"
2+
description: "When something isn't working as expected or documented"
3+
labels: ["kind/bug", "needs-triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for opening an issue. Please note that we try to keep the
9+
Terraform issue tracker reserved for bug reports and feature requests.
10+
For general usage questions, please see: https://www.terraform.io/community.html.
11+
- type: checkboxes
12+
attributes:
13+
label: Confirmation
14+
description: Please make sure to have followed the following checks.
15+
options:
16+
- label: This is a bug with an existing resource and is not a feature request or enhancement. Feature requests should be submitted with Cloudflare Support or your account team.
17+
required: true
18+
- label: I have searched the issue tracker and my issue isn't already found.
19+
required: true
20+
- label: I have replicated my issue using the latest version of the provider and it is still present.
21+
required: true
22+
- type: textarea
23+
attributes:
24+
label: Terraform and Cloudflare provider version
25+
description: |
26+
Run `terraform -v` to show the version of Terraform and providers you are
27+
using. If you are not running the latest version of Terraform or the
28+
providers, please upgrade because your issue may have already been fixed.
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: Affected resource(s)
34+
description: |
35+
Please list the resources as a list, for example:
36+
- opc_instance
37+
- opc_storage_volume
38+
39+
If this issue appears to affect multiple resources, it may be an issue with
40+
Terraform's core, so please mention this.
41+
validations:
42+
required: true
43+
- type: textarea
44+
attributes:
45+
label: Terraform configuration files
46+
description: |
47+
No need for code block backticks, this will be rendered as HCL automatically.
48+
49+
Avoid using `for` loops, dynamics or data sources in your examples as they
50+
do not make for a good reproduction test case and may contain bugs in the
51+
expressions used.
52+
53+
If you cannot provide your exact configuration due to sensitivity, please
54+
provide a minimal reproduction case that demonstrates your issue with the setup
55+
you are using.
56+
placeholder: |
57+
resource "example_resource" "my_resource" {
58+
# ..
59+
}
60+
render: hcl
61+
validations:
62+
required: true
63+
- type: input
64+
attributes:
65+
label: Link to debug output
66+
description: |
67+
A link to the output (https://gist.github.com) provided from prepending `TF_LOG=DEBUG` to your
68+
Terraform apply or plan. **Do not truncate or trim the output as the surrounding context
69+
is useful for debugging and without it, maintainers are restricted in what assistance and
70+
diagnosis they can provide**.
71+
72+
Be sure to redact or sanitise any sensitive information (such as API keys or tokens) in
73+
your logs. https://jacobbednarz.com/tf-log-redactor/ is an online tool that will handle
74+
redacting the sensitive Cloudflare details from your log output for you if you don't want
75+
to manually do it. Provider versions newer than v3.32.0 automatically redacts all Cloudflare
76+
credentials.
77+
validations:
78+
required: true
79+
- type: textarea
80+
attributes:
81+
label: Panic output
82+
description: Output from a crash or Go panic.
83+
validations:
84+
required: false
85+
- type: textarea
86+
attributes:
87+
label: Expected output
88+
description: What did you expect to happen?
89+
validations:
90+
required: true
91+
- type: textarea
92+
attributes:
93+
label: Actual output
94+
description: What actually happened?
95+
validations:
96+
required: true
97+
- type: textarea
98+
attributes:
99+
label: Steps to reproduce
100+
description: How can your issue be replicated?
101+
placeholder: |
102+
1. ...
103+
2. ...
104+
3. ...
105+
validations:
106+
required: true
107+
- type: textarea
108+
attributes:
109+
label: Additional factoids
110+
description: Is there any other important information you'd like to share?
111+
validations:
112+
required: false
113+
- type: textarea
114+
attributes:
115+
label: References
116+
description: Are there any other GitHub issues (open or closed) or Pull Requests that should be linked here?
117+
validations:
118+
required: false

0 commit comments

Comments
 (0)