Skip to content

Commit fe3e5e5

Browse files
ViacheslavKudinovViacheslavKudinov
committed
doc: Update github_repository_webhook doc
Signed-off-by: Viacheslav Kudinov <viacheslav@kudinov.tech>
1 parent 2bfaec4 commit fe3e5e5

File tree

5 files changed

+65
-48
lines changed

5 files changed

+65
-48
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ 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.
11-
For general usage questions, please see: https://github.com/integrations/terraform-provider-github/discussions.
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.
1211
1312
- type: textarea
1413
id: expected-behavior
@@ -26,31 +25,16 @@ body:
2625
validations:
2726
required: true
2827

28+
2929
- type: textarea
3030
id: terraform-version
3131
attributes:
3232
label: Terraform Version
3333
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.
3434
placeholder: |
35-
Terraform vX.Y.Z
35+
Terraform v1.2.3
3636
on linux_amd64
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 Cloud (GITHUB.com)
48-
- label: GitHub Enterprise Server/GHES (on-premises)
49-
- label: GitHub Enterprise Cloud/GHEC with Personal Accounts (GITHUB.com)
50-
- label: GitHub Enterprise Cloud/GHEC with Managed Users/EMU (GITHUB.com)
51-
- label: GitHub Enterprise Cloud with Data Residency Personal Accounts (*.GHE.com)
52-
- label: GitHub Enterprise Cloud with Data Residency and Managed Users/EMU (*.GHE.com)
53-
- label: I don't know
37+
+ provider registry.terraform.io/integrations/github v5.32.0
5438
validations:
5539
required: true
5640

@@ -72,7 +56,7 @@ body:
7256
label: Terraform Configuration Files
7357
render: hcl
7458
description: |
75-
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.
59+
Please copy and paste any relevant configration files. This will be automatically formatted into code, so no need for backticks.
7660
Please check your configuration before submission to ensure sensitive information is redacted.
7761
validations:
7862
required: false
@@ -81,7 +65,7 @@ body:
8165
id: steps-to-reproduce
8266
attributes:
8367
label: Steps to Reproduce
84-
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.
68+
description: Please list the steps required to reproduce the issue.
8569
placeholder: |
8670
```
8771
$ terraform apply
@@ -95,7 +79,17 @@ body:
9579
label: Debug Output
9680
description: |
9781
Please copy and paste any relevant debug output. This will be automatically formatted into code, so no need for backticks.
98-
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.
82+
Please check your logs before submission to ensure sensitive information is redacted.
83+
render: shell
84+
validations:
85+
required: false
86+
87+
- type: textarea
88+
id: panic-output
89+
attributes:
90+
label: Panic Output
91+
description: |
92+
Please copy and paste any relevant panic output. This will be automatically formatted into code, so no need for backticks.
9993
Please check your logs before submission to ensure sensitive information is redacted.
10094
render: shell
10195
validations:

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ body:
77
attributes:
88
value: |
99
Thanks for taking the time to fill this out!
10-
1110
- type: textarea
1211
id: describe-need
1312
attributes:
@@ -16,7 +15,22 @@ body:
1615
placeholder: Describe the need for documentation updates here.
1716
validations:
1817
required: true
19-
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
2034
- type: textarea
2135
id: logs
2236
attributes:
@@ -25,7 +39,6 @@ body:
2539
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
2640
Please check your logs before submission to ensure sensitive information is redacted.
2741
render: shell
28-
2942
- type: checkboxes
3043
id: terms
3144
attributes:

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ body:
77
attributes:
88
value: |
99
Thanks for taking the time to fill this out!
10-
1110
- type: textarea
1211
id: describe-need
1312
attributes:
@@ -16,23 +15,22 @@ body:
1615
placeholder: Describe the need for the feature.
1716
validations:
1817
required: true
19-
20-
- type: checkboxes
21-
id: github-installation
18+
- type: input
19+
id: sdk_version
2220
attributes:
23-
label: GitHub Installation Type
24-
description: What type of GitHub installation are you using?
25-
options:
26-
- label: GitHub Cloud (GITHUB.com)
27-
- label: GitHub Enterprise Server/GHES (on-premises)
28-
- label: GitHub Enterprise Cloud/GHEC with Personal Accounts (GITHUB.com)
29-
- label: GitHub Enterprise Cloud/GHEC with Managed Users/EMU (GITHUB.com)
30-
- label: GitHub Enterprise Cloud/GHEC with Data Residency Personal Accounts (*.GHE.com)
31-
- label: GitHub Enterprise Cloud/GHEC with Data Residency and Managed Users/EMU (*.GHE.com)
32-
- label: I don't know
21+
label: SDK Version
22+
description: Does this feature suggestion apply to a specific SDK version?
23+
placeholder: Octokit.rb v6.0.0
3324
validations:
34-
required: true
35-
25+
required: false
26+
- type: input
27+
id: api_version
28+
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
32+
validations:
33+
required: false
3634
- type: textarea
3735
id: logs
3836
attributes:
@@ -41,7 +39,6 @@ body:
4139
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
4240
Please check your logs before submission to ensure sensitive information is redacted.
4341
render: shell
44-
4542
- type: checkboxes
4643
id: terms
4744
attributes:

‎.github/ISSUE_TEMPLATE/maintenance.yml‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ body:
77
attributes:
88
value: |
99
Thanks for taking the time to fill this out!
10-
1110
- type: textarea
1211
id: describe-need
1312
attributes:
@@ -16,7 +15,22 @@ body:
1615
placeholder: Describe the maintenance need here.
1716
validations:
1817
required: true
19-
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
2034
- type: textarea
2135
id: logs
2236
attributes:
@@ -25,7 +39,6 @@ body:
2539
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
2640
Please check your logs before submission to ensure sensitive information is redacted.
2741
render: shell
28-
2942
- type: checkboxes
3043
id: terms
3144
attributes:

‎website/docs/r/repository_webhook.html.markdown‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,12 @@ The following additional attributes are exported:
6969
## Import
7070

7171
Repository webhooks can be imported using the `name` of the repository, combined with the `id` of the webhook, separated by a `/` character.
72-
The `id` of the webhook can be found in the URL of the webhook. For example: `"https://github.com/foo-org/foo-repo/settings/hooks/14711452"`.
72+
The `id` of the webhook can be found in the URL of the webhook. For example: `"https://github.com/foo-org/foo/settings/hooks/14711452"`, where `foo` is the name of the repository, and `14711452` is the ID of the webhook.
7373

7474
Importing uses the name of the repository, as well as the ID of the webhook, e.g.
7575

7676
```
77-
$ terraform import github_repository_webhook.terraform terraform/11235813
77+
$ terraform import github_repository_webhook.foo foo/14711452
7878
```
7979

8080
If secret is populated in the webhook's configuration, the value will be imported as "********".

0 commit comments

Comments
 (0)