terraform/website/source/docs/enterprise/vcs/github.html.md

37 lines
1.6 KiB
Markdown
Raw Normal View History

2017-03-16 20:42:33 +01:00
---
2017-03-17 22:40:42 +01:00
layout: "vcs"
page_title: "GitHub Integration"
2017-03-20 19:44:03 +01:00
sidebar_current: "docs-enterprise-vcs-github"
2017-03-17 22:40:42 +01:00
description: |-
GitHub repositories can be integrated with Terraform Enterprise by using push command.
2017-03-16 20:42:33 +01:00
---
# GitHub Integration
GitHub can be used to import Terraform configuration, automatically queuing
runs when changes are merged into a repository's default branch. Additionally,
2017-03-17 22:40:42 +01:00
plans are run when a pull request is created or updated. Terraform Enterprise will update the
2017-03-16 20:42:33 +01:00
pull request with the result of the Terraform plan providing quick feedback on
proposed changes.
## Setup
2017-03-17 22:40:42 +01:00
Terraform Enterprise environments are linked to individual GitHub repositories. However, a
single GitHub repository can be linked to multiple environments allowing
2017-03-16 20:42:33 +01:00
a single set of Terraform configuration to be used across multiple environments.
2017-03-17 22:40:42 +01:00
Environments can be linked when they're initially created using the
2017-03-16 20:42:33 +01:00
[New Environment](https://atlas.hashicorp.com/configurations/import) process.
Existing environments can be linked by setting GitHub details in their
**Integrations**.
2017-03-17 22:40:42 +01:00
To link a Terraform Enterprise environment to a GitHub repository, you need three pieces of
2017-03-16 20:42:33 +01:00
information:
- **GitHub repository** - The location of the repository being imported in the
format _username/repository_.
- **GitHub branch** - The branch from which to ingress new versions. This
defaults to the value GitHub provides as the default branch for this repository.
- **Path to directory of Terraform files** - The repository's subdirectory that
contains its terraform files. This defaults to the root of the repository.