Files
opentf/website/source/docs/providers/github/r/repository_webhook.html.markdown
Raphael Randschau 6991ceb2e2 provider/github: add repository_webhook resource (#12924)
* provider/github: add repository_webhook resource

`repository_webhook` can be used to manage webhooks for repositories.
It is currently limited to organization repositories only.

The changeset includes both documentation and tests.
The tests are green:

```
make testacc TEST=./builtin/providers/github
TESTARGS='-run=TestAccGithubRepositoryWebhook_basic'
==> Checking that code complies with gofmt requirements...
go generate $(go list ./... | grep -v /terraform/vendor/)
2017/03/21 16:20:07 Generated command/internal_plugin_list.go
TF_ACC=1 go test ./builtin/providers/github -v
-run=TestAccGithubRepositoryWebhook_basic -timeout 120m
=== RUN   TestAccGithubRepositoryWebhook_basic
--- PASS: TestAccGithubRepositoryWebhook_basic (5.10s)
PASS
ok      github.com/hashicorp/terraform/builtin/providers/github    5.113s
```

* provider/github: add github_organization_webhook

the `github_organization_webhook` resource is similar to the
`github_repository_webhook` resource, but it manages webhooks for an
organization.

the tests are green:

```
make testacc TEST=./builtin/providers/github
TESTARGS='-run=TestAccGithubOrganizationWebhook'
==> Checking that code complies with gofmt requirements...
go generate $(go list ./... | grep -v /terraform/vendor/)
2017/03/21 17:23:33 Generated command/internal_plugin_list.go
TF_ACC=1 go test ./builtin/providers/github -v
-run=TestAccGithubOrganizationWebhook -timeout 120m
=== RUN   TestAccGithubOrganizationWebhook_basic
--- PASS: TestAccGithubOrganizationWebhook_basic (2.09s)
PASS
ok      github.com/hashicorp/terraform/builtin/providers/github    2.109s
```
2017-03-23 11:21:45 +02:00

1.6 KiB

layout, page_title, sidebar_current, description
layout page_title sidebar_current description
github GitHub: github_repository_webhook docs-github-resource-repository-webhook Creates and manages repository webhooks within Github organizations

github_repository_webhook

This resource allows you to create and manage webhooks for repositories within your Github organization.

This resource cannot currently be used to manage webhooks for personal repositories, outside of organizations.

Example Usage

resource "github_repository" "repo" {
  name = "foo"
  description = "Terraform acceptance tests"
  homepage_url = "http://example.com/"

  private = false
}

resource "github_repository_webhook" "foo" {
  repository = "${github_repository.repo.name}"

  name = "web"
  configuration {
    url = "https://google.de/"
    content_type = "form"
    insecure_ssl = false
  }
  active = false

  events = ["issues"]
}

Argument Reference

The following arguments are supported:

  • name - (Required) The type of the webhook. See a list of available hooks.

  • repository - (Required) The repository of the webhook.

  • events - (Required) A list of events which should trigger the webhook. Defaults to ["push"]. See a list of available events

  • config - (Required) key/value pair of configuration for this webhook. Available keys are url, content_type, secret and insecure_ssl.

  • active - (Optional) Indicate of the webhook should receive events. Defaults to true.

Attributes Reference

The following additional attributes are exported:

  • url - URL of the webhook