Skip to content

Commit 893fcb7

Browse files
authored
Remove unused name variable (#8)
* Remove unused `name` variable * Remove unused `name` variable
1 parent b089191 commit 893fcb7

File tree

4 files changed

+8
-13
lines changed

4 files changed

+8
-13
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [yyyy] [name of copyright owner]
189+
Copyright 2017-2019 Cloud Posse, LLC
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ We literally have [*hundreds of terraform modules*][terraform_modules] that are
4545

4646
## Usage
4747

48+
49+
**IMPORTANT:** The `master` branch is used in `source` just as an example. In your code, do not pin to `master` because there may be breaking changes between releases.
50+
Instead pin to the release tag (e.g. `?ref=tags/x.y.z`) of one of our [latest releases](https://github.com/cloudposse/terraform-github-repository-webhooks/releases).
51+
52+
4853
Create a GitHub Personal Access Token that has `admin:repo_hook` for full control of repository hooks; in otherwords, we need `write:repo_hook` to write repository hooks and `read:repo_hook` to read repository hooks.
4954

5055
```hcl
@@ -54,7 +59,7 @@ module "github_webhooks" {
5459
github_token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
5560
github_repositories = "geodesic"
5661
webhook_url = "https://atlantis.prod.company.com/"
57-
content_type = "json"
62+
content_type = "application/json"
5863
events = ["issues"]
5964
}
6065
```
@@ -84,7 +89,6 @@ Available targets:
8489
| github_organization | GitHub organization to use when creating webhook | string | - | yes |
8590
| github_repositories | List of repository names which should be associated with the webhook | list | `<list>` | no |
8691
| github_token | GitHub token used for API access | string | - | yes |
87-
| name | The type of webhook | string | `web` | no |
8892
| webhook_content_type | Webhook Content Type (E.g. json) | string | `json` | no |
8993
| webhook_insecure_ssl | Webhook Insecure SSL (E.g. trust self-signed certificates) | string | `false` | no |
9094
| webhook_secret | Webhook secret | string | `` | no |
@@ -180,7 +184,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
180184

181185
## Copyright
182186

183-
Copyright © 2017-2018 [Cloud Posse, LLC](https://cpco.io/copyright)
187+
Copyright © 2017-2019 [Cloud Posse, LLC](https://cpco.io/copyright)
184188

185189

186190

docs/terraform.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
| github_organization | GitHub organization to use when creating webhook | string | - | yes |
99
| github_repositories | List of repository names which should be associated with the webhook | list | `<list>` | no |
1010
| github_token | GitHub token used for API access | string | - | yes |
11-
| name | The type of webhook | string | `web` | no |
1211
| webhook_content_type | Webhook Content Type (E.g. json) | string | `json` | no |
1312
| webhook_insecure_ssl | Webhook Insecure SSL (E.g. trust self-signed certificates) | string | `false` | no |
1413
| webhook_secret | Webhook secret | string | `` | no |

variables.tf

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,6 @@ variable "enabled" {
33
default = "true"
44
}
55

6-
variable "name" {
7-
# This is what GitHub calls it. It's must be one of these predefined types.
8-
# https://api.github.com/hooks
9-
description = "The type of webhook"
10-
11-
default = "web"
12-
}
13-
146
variable "github_token" {
157
description = "GitHub token used for API access"
168
}

0 commit comments

Comments
 (0)