Skip to content

Commit 68672d2

Browse files
committed
improve template bug github issue template
1 parent ff34981 commit 68672d2

File tree

2 files changed

+71
-66
lines changed

2 files changed

+71
-66
lines changed

.github/ISSUE_TEMPLATE/workspace-template-bug-report.md

Lines changed: 0 additions & 66 deletions
This file was deleted.
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: "Workspace Template Bug Report"
2+
description: "Workspace template yielded incorrect parameters."
3+
title: "param-bug: "
4+
labels: ["bug"]
5+
assignees:
6+
- Emyrk
7+
body:
8+
- type: textarea
9+
id: issue
10+
attributes:
11+
label: "Describe the bug"
12+
description: |
13+
A clear and concise description of what the bug is.
14+
Was the parameter value/description/options/etc incorrect?
15+
Did you encounter an error you did not expect?
16+
Did you expect to encounter an error, and did not?
17+
placeholder: "A parameter that I expected is missing. The parameter is sourced from an external module."
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: template
23+
attributes:
24+
label: "Offending Template"
25+
description: |
26+
Provide the most minimal workspace template that reproduces the bug.
27+
Try to remove any non-coder terraform blocks.
28+
Only `data "coder_parameter"` and `data "coder_workspace_tags"`
29+
with any supporting or referenced blocks are required.
30+
31+
If the template is a single `main.tf`, please include the `main.tf` in the collapsible section below.
32+
If there are multiple files, either attach the files, or create a public github repository with the directory structure.
33+
Try to avoid attaching zips or tarballs.
34+
value: |
35+
<details>
36+
37+
<summary>Template `main.tf`</summary>
38+
39+
```terraform
40+
# Replace this with your `main.tf`
41+
terraform {
42+
required_providers {
43+
coder = {
44+
source = "coder/coder"
45+
version = "2.3.0"
46+
}
47+
}
48+
}
49+
```
50+
51+
</details>
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: screenshots
57+
attributes:
58+
label: "Screenshots"
59+
description: |
60+
If applicable, add screenshots to help explain your problem.
61+
validations:
62+
required: false
63+
64+
- type: textarea
65+
id: additional
66+
attributes:
67+
label: "Additional context"
68+
description: |
69+
Add any other context about the problem here.
70+
validations:
71+
required: false

0 commit comments

Comments
 (0)