ghbranch

Package ghbranch provides methods to create github_branch terraform resource

Functions

func New

func New(c ConfigProvider) *hclwrite.Block

New returns the github_branch terraform resource as hclwrite.Block

It returns nil if resource is empty.

valGen := gh2tf.NewValueGenerator()
repoName := "repository_name"
branchName := "my_default_branch_name"
sourceBranch := "source_branch_name"
sourceSha := "a_sha"
repoNameAsLink := "github_repository.res-id.name"
branchNameAsLink := "github_branch.res-id.branch"

res := &ghbranch.Config{
    valGen,
    "res-id",
    &repoName,
    &branchName,
    nil,
    nil,
}
resWithSourceBranch := &ghbranch.Config{
    valGen,
    "res-with-source-branch",
    &repoNameAsLink,
    &branchName,
    &sourceBranch,
    nil,
}
resWithSourceSha := &ghbranch.Config{
    valGen,
    "res-with-source-sha",
    &repoName,
    &branchNameAsLink,
    nil,
    &sourceSha,
}

hclFile := hclwrite.NewEmptyFile()
hclFile.Body().AppendBlock(ghbranch.New(res))
hclFile.Body().AppendBlock(ghbranch.New(resWithSourceBranch))
hclFile.Body().AppendBlock(ghbranch.New(resWithSourceSha))
fmt.Println(string(hclFile.Bytes()))

Output:

resource "github_branch" "res-id" {
  repository = "repository_name"
  branch     = "my_default_branch_name"
}
resource "github_branch" "res-with-source-branch" {
  repository    = github_repository.res-id.name
  branch        = "my_default_branch_name"
  source_branch = "source_branch_name"
}
resource "github_branch" "res-with-source-sha" {
  repository = "repository_name"
  branch     = github_branch.res-id.branch
  source_sha = "a_sha"
}

func NewSignature

func NewSignature(conf ConfigProvider) *tfsig.BlockSignature

NewSignature returns the github_branch terraform resource as tfsig.BlockSignature

It returns nil if resource is empty.

Types

type Config

type Config struct { ... }

Config is the default implementation of ConfigProvider.

func (*Config) BranchValue

func (c *Config) BranchValue() *cty.Value

BranchValue return the provided github_branch branch attribute value as cty.String or nil if not provided.

func (*Config) HasResource

func (c *Config) HasResource() bool

HasResource returns true in case at least Config and Repository value exist, else false.

func (*Config) RepositoryValue

func (c *Config) RepositoryValue() *cty.Value

RepositoryValue return the provided github_branch repository attribute value as cty.String or nil if not provided.

func (*Config) ResourceIdentifier

func (c *Config) ResourceIdentifier() string

ResourceIdentifier returns the provided terraform resource identifier.

func (*Config) SourceBranchValue

func (c *Config) SourceBranchValue() *cty.Value

SourceBranchValue return the provided github_branch source_branch attribute value as cty.String or nil if not provided.

func (*Config) SourceShaValue

func (c *Config) SourceShaValue() *cty.Value

SourceShaValue return the provided github_branch source_sha attribute value as cty.String or nil if not provided.

type ConfigProvider

type ConfigProvider interface { ... }

ConfigProvider defines required methods to be used when creating github_branch terraform resource.

Readme created from Go doc with goreadme

# README