Git Product home page Git Product logo

terratalk's Introduction

terratalk

build and publish Coverage Status PyPI PyPI - Downloads License

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

terratalk on Bitbucket Server

License

MIT

terratalk's People

Contributors

dependabot[bot] avatar lgtm-com[bot] avatar lifeofguenter avatar rchl avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

terratalk's Issues

Combine outputs to post only a single comment

Currently, the script is run separately for both stage and prod. What do you think about a mode where we would collect TF outputs into a variable (in the pipeline) and only run the script once both have completed, creating only one comment?

(Just looking for ways to limit the number of unnecessary notifications.)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.