Getting Started
Step 1
Click here to install Terrateam from the GitHub Marketplace (opens in a new tab)
Install the Terrateam GitHub application on any repository with Terraform code.
Step 2
Click here for the Terrateam GitHub Actions workflow file (opens in a new tab)
The Terrateam GitHub workflow file must be stored in the default branch
of your Terraform repository. The default branch
is usually named main
or master
.
.github/workflows/terrateam.yml
Detailed Instructions
💡 Expand for detailed workflow file setup instructions
Terrateam GitHub Actions workflow file setup
- Create a new branch in your repository
git checkout -b terrateam-setup
- Create a
.github/workflows
directory
mkdir -p .github/workflows
- Store the Terrateam GitHub Actions workflow file in the
.github/workflows
directory
curl -L -o .github/workflows/terrateam.yml \
https://terrateam.io/.github/workflows/terrateam.yml
- Commit and push
.github/workflows/
to your branch
git add .github/workflows/ && \
git commit .github/workflows/ -m "Terrateam GitHub Actions workflow file" && \
git push --set-upstream origin terrateam-setup
- Create a pull request to merge your changes into the default branch
gh pr create --fill
- Merge your new pull request
Next Steps
Pull Request
Create a Pull Request with a Terraform code change
- Create a pull request with a Terraform code change
- Terrateam will automatically run
terraform plan
and comment back the output - Comment on the pull request with
terrateam apply
to apply changes - Merge the pull request
Common Use Cases
Click here to see configurations for common use cases
Configuration
Learn how to fully customize your workflow with our runtime configuration file.
Support
Join our Community Slack or email support if you need help on-boarding.