Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS]: github_organization_webhook missing org name #2307

Open
1 task done
ayakout-magna opened this issue Jul 4, 2024 · 0 comments
Open
1 task done

[DOCS]: github_organization_webhook missing org name #2307

ayakout-magna opened this issue Jul 4, 2024 · 0 comments
Labels
Status: Triage This is being looked at and prioritized Type: Documentation Improvements or additions to documentation

Comments

@ayakout-magna
Copy link

Describe the need

In Terraform's GitHub provider, the github_organization_webhook resource is designed to manage webhooks at the organization level within GitHub. However, unlike its counterpart github_repository_webhook, which includes a field for specifying the repository name, the github_organization_webhook resource does not have an explicit field to define the organization name.

Issue Details
When configuring the github_organization_webhook resource, users are expected to define various attributes such as the webhook URL, events to listen for, and security settings. A typical configuration might look like this:

resource "github_organization_webhook" "example" {
  url    = "https://example.com/webhook"
  events = ["push", "pull_request"]

  configuration {
    content_type = "json"
    insecure_ssl = false
    secret       = "my_secret_token"
  }

  active = true
}

The Problem
The issue arises because the github_organization_webhook resource does not include a field to specify which organization the webhook should be created for. This contrasts with the github_repository_webhook resource, where you can explicitly set the repository name:

resource "github_repository_webhook" "example" {
  repository = "my-repo"
  url        = "https://example.com/webhook"
  events     = ["push"]

  configuration {
    content_type = "json"
    insecure_ssl = false
    secret       = "my_secret_token"
  }

  active = true
}

SDK Version

No response

API Version

No response

Relevant log output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@ayakout-magna ayakout-magna added Status: Triage This is being looked at and prioritized Type: Documentation Improvements or additions to documentation labels Jul 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Triage This is being looked at and prioritized Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant