Skip to content

Commit 7db868a

Browse files
ViacheslavKudinovdeiga
ViacheslavKudinov
and
deiga
authored
[MAINT] Update issue templates (#3261)
* Update issue templates * Update issue templates * Update .github/ISSUE_TEMPLATE/bug.yml Co-authored-by: Timo Sand <timo.sand@iki.fi> * Update .github/ISSUE_TEMPLATE/bug.yml Co-authored-by: Timo Sand <timo.sand@iki.fi> * Update .github/ISSUE_TEMPLATE/bug.yml Co-authored-by: Timo Sand <timo.sand@iki.fi> * Update bug template * Removed panic logs field * chore: Update templates according to suggestions Signed-off-by: Viacheslav Kudinov <viacheslav@kudinov.tech> --------- Signed-off-by: Viacheslav Kudinov <viacheslav@kudinov.tech> Co-authored-by: Timo Sand <timo.sand@iki.fi>
1 parent 0eb24b5 commit 7db868a

4 files changed

Lines changed: 44 additions & 62 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ body:
77
attributes:
88
value: |
99
Hi there,
10-
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.
10+
Thank you for opening an issue. Please note that we try to keep the Terraform issue tracker reserved for bug reports and feature requests.
11+
For general usage questions, please see: https://github.com/integrations/terraform-provider-github/discussions.
1112
1213
- type: textarea
1314
id: expected-behavior
@@ -31,9 +32,24 @@ body:
3132
label: Terraform Version
3233
description: Run `terraform -v` to show the version. If you are not running the latest version of Terraform, please upgrade because your issue may have already been fixed.
3334
placeholder: |
34-
Terraform v1.2.3
35+
Terraform vX.Y.Z
3536
on linux_amd64
36-
+ provider registry.terraform.io/integrations/github v5.32.0
37+
+ provider registry.terraform.io/integrations/github vX.Y.Z
38+
validations:
39+
required: true
40+
41+
- type: checkboxes
42+
id: github-installation
43+
attributes:
44+
label: GitHub Installation Type
45+
description: What type of GitHub installation are you using?
46+
options:
47+
- label: GitHub.com (Free, Pro, or Team)
48+
- label: GitHub Enterprise Server (on-premises)
49+
- label: GitHub Enterprise Cloud with Personal Accounts (github.com)
50+
- label: GitHub Enterprise Cloud with Managed Users/EMU (github.com)
51+
- label: GitHub Enterprise Cloud with Data Residency (*.ghe.com)
52+
- label: I don't know
3753
validations:
3854
required: true
3955

@@ -55,7 +71,7 @@ body:
5571
label: Terraform Configuration Files
5672
render: hcl
5773
description: |
58-
Please copy and paste any relevant configration files. This will be automatically formatted into code, so no need for backticks.
74+
Please copy and paste any relevant configuration files. This will be automatically formatted into code, so no need for backticks. If this configuration is inside a Module, please mention that.
5975
Please check your configuration before submission to ensure sensitive information is redacted.
6076
validations:
6177
required: false
@@ -64,7 +80,7 @@ body:
6480
id: steps-to-reproduce
6581
attributes:
6682
label: Steps to Reproduce
67-
description: Please list the steps required to reproduce the issue.
83+
description: Please list the steps required to reproduce the issue. Remember to mention any configuration outside of Terraform that could be relevant to the issue.
6884
placeholder: |
6985
```
7086
$ terraform apply
@@ -78,17 +94,7 @@ body:
7894
label: Debug Output
7995
description: |
8096
Please copy and paste any relevant debug output. This will be automatically formatted into code, so no need for backticks.
81-
Please check your logs before submission to ensure sensitive information is redacted.
82-
render: shell
83-
validations:
84-
required: false
85-
86-
- type: textarea
87-
id: panic-output
88-
attributes:
89-
label: Panic Output
90-
description: |
91-
Please copy and paste any relevant panic output. This will be automatically formatted into code, so no need for backticks.
97+
Please run your `terraform` command with `TF_LOG=DEBUG` set, then copy and paste the output. This will be automatically formatted into code, so no need for backticks.
9298
Please check your logs before submission to ensure sensitive information is redacted.
9399
render: shell
94100
validations:

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ body:
77
attributes:
88
value: |
99
Thanks for taking the time to fill this out!
10+
1011
- type: textarea
1112
id: describe-need
1213
attributes:
@@ -15,22 +16,7 @@ body:
1516
placeholder: Describe the need for documentation updates here.
1617
validations:
1718
required: true
18-
- type: input
19-
id: sdk_version
20-
attributes:
21-
label: SDK Version
22-
description: Do these docs apply to a specific SDK version?
23-
placeholder: Octokit.NET v4.0.1
24-
validations:
25-
required: false
26-
- type: input
27-
id: api_version
28-
attributes:
29-
label: API Version
30-
description: Do these docs apply to a specific version of the GitHub REST API or GraphQL API?
31-
placeholder: ex. v1.1.1
32-
validations:
33-
required: false
19+
3420
- type: textarea
3521
id: logs
3622
attributes:
@@ -39,6 +25,7 @@ body:
3925
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
4026
Please check your logs before submission to ensure sensitive information is redacted.
4127
render: shell
28+
4229
- type: checkboxes
4330
id: terms
4431
attributes:

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ body:
77
attributes:
88
value: |
99
Thanks for taking the time to fill this out!
10+
1011
- type: textarea
1112
id: describe-need
1213
attributes:
@@ -15,22 +16,22 @@ body:
1516
placeholder: Describe the need for the feature.
1617
validations:
1718
required: true
18-
- type: input
19-
id: sdk_version
20-
attributes:
21-
label: SDK Version
22-
description: Does this feature suggestion apply to a specific SDK version?
23-
placeholder: Octokit.rb v6.0.0
24-
validations:
25-
required: false
26-
- type: input
27-
id: api_version
19+
20+
- type: checkboxes
21+
id: github-installation
2822
attributes:
29-
label: API Version
30-
description: Does this feature suggestion apply to a specific version of the GitHub REST API or GraphQL API?
31-
placeholder: ex. v1.1.1
23+
label: GitHub Installation Type
24+
description: What type of GitHub installation are you using?
25+
options:
26+
- label: GitHub.com (Free, Pro, or Team)
27+
- label: GitHub Enterprise Server (on-premises)
28+
- label: GitHub Enterprise Cloud with Personal Accounts (github.com)
29+
- label: GitHub Enterprise Cloud with Managed Users/EMU (github.com)
30+
- label: GitHub Enterprise Cloud with Data Residency (*.ghe.com)
31+
- label: I don't know
3232
validations:
33-
required: false
33+
required: true
34+
3435
- type: textarea
3536
id: logs
3637
attributes:
@@ -39,6 +40,7 @@ body:
3940
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
4041
Please check your logs before submission to ensure sensitive information is redacted.
4142
render: shell
43+
4244
- type: checkboxes
4345
id: terms
4446
attributes:

‎.github/ISSUE_TEMPLATE/maintenance.yml‎

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ body:
77
attributes:
88
value: |
99
Thanks for taking the time to fill this out!
10+
1011
- type: textarea
1112
id: describe-need
1213
attributes:
@@ -15,22 +16,7 @@ body:
1516
placeholder: Describe the maintenance need here.
1617
validations:
1718
required: true
18-
- type: input
19-
id: sdk_version
20-
attributes:
21-
label: SDK Version
22-
description: Does this maintenance apply to a specific SDK version?
23-
placeholder: terraform-provider-github v5.7.0
24-
validations:
25-
required: false
26-
- type: input
27-
id: api_version
28-
attributes:
29-
label: API Version
30-
description: Does this maintenance apply to a specific version of the GitHub REST API or GraphQL API?
31-
placeholder: ex. v1.1.1
32-
validations:
33-
required: false
19+
3420
- type: textarea
3521
id: logs
3622
attributes:
@@ -39,6 +25,7 @@ body:
3925
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
4026
Please check your logs before submission to ensure sensitive information is redacted.
4127
render: shell
28+
4229
- type: checkboxes
4330
id: terms
4431
attributes:

0 commit comments

Comments
 (0)