A Terraform commentator.
Project description
terratalk
Terratalk is a simple tool to add an opinionated terraform plan output into your pull-request as a comment. This allows you to have a quick feedback on infrastructure changes without having to leave the context of your pull-request view.
Setup
Prerequisite
This tool relies on either
Bitbucket Branch Source
or GitHub Branch Source to
be installed as a plugin on your Jenkins. Alternatively you can set the
environment variable CHANGE_URL
to the URL of the pull-request which will
allow terratalk
to construct the proper API request to your SCM.
GitLab is currently only supported from gitlab-pipelines.
Installation
On the build agent, install terratalk
:
$ pip install --user terratalk
If you are using GitHub you will additionally need to install the following:
$ pip install --user PyGithub
If you are using GitLab you will additionally need to install the following:
$ pip install --user python-gitlab
Running
Execute in the same directory, optionally with the same TF_DATA_DIR
as you
would normally run terraform
. If you use
tfenv
that will work as well.
$ terraform plan -out WORKSPACE.plan
$ terratalk comment -w WORKSPACE
Supported environment variables
Bitbucket Server
STASH_USER
STASH_PASS
Bitbucket Cloud
BITBUCKET_USERNAME
BITBUCKET_APP_PASSWORD
GitHub
GITHUB_TOKEN
GitLab
GITLAB_TOKEN
Results
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for terratalk-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f99e98c3d5542ce1824a0852856f6288e69491c33d162977f67c028616b8a1b |
|
MD5 | db0ea4f91dfaf371eb33a96b7f4c9ef5 |
|
BLAKE2b-256 | e9441114a5f9ce34c299988071e06af2b2bbdc96e32f9c9fac4dc41c6393cd2b |