views

Documentation

Index

• type BreakingChangeView
  • func NewBreakingChangesView(input []changes.Change) BreakingChangeView
  • func (v BreakingChangeView) RenderMarkdown() (*string, error)
• type ChangesView
  • func NewChangesView(input []changes.Change) ChangesView
  • func (v ChangesView) RenderMarkdown() (*string, error)
• type ResourceIdSegmentsView
  • func NewResourceIdSegmentsView(input []changes.Change) ResourceIdSegmentsView
  • func (v ResourceIdSegmentsView) RenderMarkdown() (*string, error)
• type View

Types

type BreakingChangeView

type BreakingChangeView struct {
	// contains filtered or unexported fields
}

BreakingChangeView renders the UI when Breaking Changes are detected.

func NewBreakingChangesView

func NewBreakingChangesView(input []changes.Change) BreakingChangeView

func (BreakingChangeView) RenderMarkdown

func (v BreakingChangeView) RenderMarkdown() (*string, error)

RenderMarkdown renders the Breaking Changes View using Markdown, intended for both display in a Terminal and to be output as a GitHub Comment.

type ChangesView

type ChangesView struct {
	// contains filtered or unexported fields
}

ChangesView renders the UI when any Changes are detected.

func NewChangesView

func NewChangesView(input []changes.Change) ChangesView

func (ChangesView) RenderMarkdown

func (v ChangesView) RenderMarkdown() (*string, error)

RenderMarkdown renders the Changes View using Markdown, intended for both display in a Terminal and to be output as a GitHub Comment.

type ResourceIdSegmentsView

type ResourceIdSegmentsView struct {
	// contains filtered or unexported fields
}

func NewResourceIdSegmentsView

func NewResourceIdSegmentsView(input []changes.Change) ResourceIdSegmentsView

func (ResourceIdSegmentsView) RenderMarkdown

func (v ResourceIdSegmentsView) RenderMarkdown() (*string, error)

type View

type View interface {
	// RenderMarkdown renders the View using Markdown, intended for both display
	// in a Terminal and to be output as a GitHub Comment.
	RenderMarkdown() (*string, error)
}