Giter Club home page Giter Club logo

tfvc's Introduction

Terraform Version Check

release GoReportCard Go version

Terraform version check (tfvc) is a reporting tool to identify available updates for providers and modules referenced in your Terraform code. It provides clear warning/failure output and resolution guidance for any issues it detects.

NOTE: This project is currently under heavy development and things WILL break (probably)

Example output

Example output

Installation

Install with Homebrew on MacOS or Linux.

brew install tfverch/tfvc/tfvc

Install with Go

go install github.com/tfverch/tfvc@latest

Usage

tfvc will scan the specified directories and report on the configuration of providers and module calls.

The exit status will be non-zero if tfvc finds problems, otherwise the exit status will be zero.

tfvc .

The following parameters are available.

Parameter Type Description
--include-passed, -a bool (default: false) Include passed checks in console output
--include-prerelease, -e bool (default: false) Include prerelease versions in checks
--ssh-private-key-path, -s, string (default: "") Path to private key to use for SSH module calls
--ssh-private-key-pwd, -w string (default: "") Password for private key file if required

Docker usage

As an alternative to installing and running tfvc on your system, you can run tfvc in a Docker container, for example:

docker run --rm -it -v "$(pwd):/src" tfverch/tfvc /src

Motivation

While tools such as dependabot and renovate provide fully automate dependency updates, I needed something with a lighter touch. tfvc aims to be a simple reporting tool that can be run either locally, or as part of a CI/CD pipeline, to give you feedback on any modules or providers which have updates available.

Acknowledgements

This project started as a fork of the github.com/keilerkonzept/terraform-module-versions project. However, given the changes that I needed to make to add the features that I wanted to, I ended up migrating to this repo. Still, shout out to keilerkonzept for their work.

tfvc's People

Contributors

ryan-jan avatar sgreben avatar renovate-bot avatar semantic-release-bot avatar dawidmalina avatar renovate[bot] avatar bmwtsn098 avatar josh-barker avatar favoretti avatar

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.