Skip to content

cloudposse/terraform-github-repository-webhooks

 
 

terraform-github-repository-webhooks

Codefresh Build Status Latest Release Slack Community

README Header

Cloud Posse

Terraform module to provision webhooks on a set of GitHub repositories. This is useful if you need to register a webhook en masse across dozens of repositories.


This project is part of our comprehensive "SweetOps" approach towards DevOps.

Terraform Open Source Modules

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Usage

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. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

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.

For a complete example, see examples/complete.

module "github_webhooks" { source = "git::https://github.com/cloudposse/terraform-github-repository-webhooks.git?ref=master" github_organization = "cloudposse" github_token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" github_repositories = ["geodesic"] webhook_url = "https://atlantis.prod.company.com" webhook_content_type = "json" events = ["issues"] }

Makefile Targets

Available targets: help Help screen help/all Display help for all targets help/short This help short screen lint Lint terraform code 

Requirements

Name Version
terraform ~> 0.12.0
github ~> 2.8.0
local ~> 1.2

Providers

Name Version
github ~> 2.8.0

Inputs

Name Description Type Default Required
active Indicate of the webhook should receive events bool true no
enabled Whether or not to enable this module bool true no
events A list of events which should trigger the webhook. list(string)
[
"issue_comment",
"pull_request",
"pull_request_review",
"pull_request_review_comment"
]
no
github_anonymous Github Anonymous API (if true, token must not be set as GITHUB_TOKEN or github_token) bool false no
github_base_url GitHub target API endpoint string "https://api.github.com/" no
github_organization GitHub organization to use when creating webhooks string n/a yes
github_repositories List of repository names which should be associated with the webhook list(string) [] no
github_token GitHub token used for API access. If not provided, can be sourced from the GITHUB_TOKEN environment variable string "" no
webhook_content_type Webhook Content Type (e.g. json) string "json" no
webhook_insecure_ssl Webhook Insecure SSL (e.g. trust self-signed certificates) bool false no
webhook_secret Webhook secret string "" no
webhook_url Webhook URL string n/a yes

Outputs

Name Description
webhook_url Webhook URL

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

References

For additional context, refer to some of these links.

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

README Commercial Support

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Learn More

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

  • Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
  • Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
  • Site Reliability Engineering. You'll have total visibility into your apps and microservices.
  • Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
  • GitOps. You'll be able to operate your infrastructure via Pull Requests.
  • Training. You'll receive hands-on training so your team can operate what we build.
  • Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
  • Troubleshooting. You'll get help to triage when things aren't working.
  • Code Reviews. You'll receive constructive feedback on Pull Requests.
  • Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

Discourse Forums

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Newsletter

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

zoom

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

Copyright © 2017-2020 Cloud Posse, LLC

License

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

Cloud Posse

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Erik Osterman
Erik Osterman
Igor Rodionov
Igor Rodionov
Andriy Knysh
Andriy Knysh

README Footer Beacon

Sponsor this project

 

Packages

No packages published

Contributors 17