Skip to content

Commit 1f7497f

Browse files
feat: issue templates (#284)
1 parent aa37f99 commit 1f7497f

3 files changed

Lines changed: 160 additions & 0 deletions

File tree

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
name: Bug Report
2+
description: Report a problem with tf-migrate
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for filing a bug report. Please fill out the sections below so we can reproduce and fix the issue.
9+
10+
- type: input
11+
id: version
12+
attributes:
13+
label: tf-migrate version
14+
description: Output of `tf-migrate version` or the commit/tag you're using.
15+
placeholder: "e.g. v0.3.0 or commit abc1234"
16+
validations:
17+
required: true
18+
19+
- type: dropdown
20+
id: migration-path
21+
attributes:
22+
label: Migration path
23+
options:
24+
- v4 to v5
25+
- v5 to v5 (bypass)
26+
- Other
27+
validations:
28+
required: true
29+
30+
- type: input
31+
id: resource-type
32+
attributes:
33+
label: Affected resource type(s)
34+
description: The Cloudflare resource type(s) involved.
35+
placeholder: "e.g. cloudflare_zone_settings_override, cloudflare_dns_record"
36+
validations:
37+
required: false
38+
39+
- type: textarea
40+
id: description
41+
attributes:
42+
label: Description
43+
description: A clear description of what went wrong.
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: input-config
49+
attributes:
50+
label: Input configuration
51+
description: The `.tf` configuration before migration (redact any secrets).
52+
render: hcl
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: expected
58+
attributes:
59+
label: Expected output
60+
description: What you expected the migrated configuration to look like.
61+
render: hcl
62+
validations:
63+
required: false
64+
65+
- type: textarea
66+
id: actual
67+
attributes:
68+
label: Actual output
69+
description: What tf-migrate actually produced (or the error message).
70+
render: shell
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: reproduce
76+
attributes:
77+
label: Steps to reproduce
78+
description: Exact commands to reproduce the issue.
79+
placeholder: |
80+
1. tf-migrate migrate --config-dir ./my-tf --source-version v4 --target-version v5
81+
2. ...
82+
validations:
83+
required: false
84+
85+
- type: textarea
86+
id: context
87+
attributes:
88+
label: Additional context
89+
description: Anything else that might help (Terraform version, provider version, OS, logs with `--log-level debug`, etc.).
90+
validations:
91+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Cloudflare Terraform Provider Docs
4+
url: https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs
5+
about: Official Cloudflare Terraform provider documentation
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Feature Request
2+
description: Suggest a new feature or improvement for tf-migrate
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for suggesting an improvement. Please describe what you'd like and why it would be useful.
9+
10+
- type: dropdown
11+
id: category
12+
attributes:
13+
label: Category
14+
options:
15+
- New resource migration support
16+
- Improvement to existing migration
17+
- CLI / UX improvement
18+
- Testing / CI improvement
19+
- Documentation
20+
- Other
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: problem
26+
attributes:
27+
label: Problem or motivation
28+
description: What problem does this solve, or what workflow does it improve?
29+
placeholder: "I'm trying to migrate X but tf-migrate doesn't handle Y..."
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: proposal
35+
attributes:
36+
label: Proposed solution
37+
description: Describe the feature or change you'd like to see.
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: config-example
43+
attributes:
44+
label: Configuration example
45+
description: If applicable, show the input and desired output `.tf` configuration.
46+
render: hcl
47+
validations:
48+
required: false
49+
50+
- type: textarea
51+
id: alternatives
52+
attributes:
53+
label: Alternatives considered
54+
description: Any workarounds or alternative approaches you've considered.
55+
validations:
56+
required: false
57+
58+
- type: textarea
59+
id: context
60+
attributes:
61+
label: Additional context
62+
description: Anything else — links to provider docs, related issues, scale of impact, etc.
63+
validations:
64+
required: false

0 commit comments

Comments
 (0)