tfplan

Documentation

Overview

Package tfplan can read a subset of the Terraform plan format at various versions.

The plan file format is not a documented interface and so it is subject to change at any time. This package makes a best effort to snapshot the format at various points to enable callers to load plans of different versions, but there is no guarantee that the result is complete, and new versions of the plan format can be released at any time which this library may or may not support.

Index

• func LoadPlan(src io.Reader) (interface{}, error)

Functions

func LoadPlan

func LoadPlan(src io.Reader) (interface{}, error)

LoadPlan reads a Terraform plan from the given reader and returns it.

Different plan versions use different types, so the value returned may be any of the following types depending on the version:

github.com/apparentlymart/go-tfplan/tfplan/v1 *Plan (version 1)
github.com/apparentlymart/go-tfplan/tfplan/v2 *Plan (version 2)

Use a type switch to recognize the versions you wish to support and then handle each version separately. New plan types may be returned by future versions, so be sure to handle the "default" case of the type switch.