summaryengine

package
v0.9.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 31, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const CommentMarker = ci.CommentMarker

CommentMarker is used to identify terraci comments for updates

Variables

This section is empty.

Functions

func ComposeComment added in v0.7.4

func ComposeComment(plans []ci.ModulePlan, reports []*ci.Report, commitSHA, pipelineID string, generatedAt time.Time) string

ComposeComment builds the final markdown comment from plans and plugin reports.

func EnrichPlans added in v0.7.4

func EnrichPlans(plans []ci.ModulePlan, modules []ci.ModuleReport)

EnrichPlans applies per-module data from report modules to plan data.

func FormatCostCell

func FormatCostCell(p *ci.ModulePlan) string

FormatCostCell formats the cost cell for a module plan

func FormatCostDiff

func FormatCostDiff(diff float64) string

FormatCostDiff formats a cost difference with sign

func FormatMonthlyCost

func FormatMonthlyCost(cost float64) string

FormatMonthlyCost formats a monthly cost value

func Truncate

func Truncate(s string, maxLen int) string

Truncate truncates a string to maxLen characters

Types

type Config added in v0.7.5

type Config struct {
	Enabled        *bool    `yaml:"enabled,omitempty" json:"enabled,omitempty"`
	OnChangesOnly  bool     `yaml:"on_changes_only,omitempty" json:"on_changes_only,omitempty"`
	IncludeDetails bool     `yaml:"include_details,omitempty" json:"include_details,omitempty"`
	Labels         []string `yaml:"labels,omitempty" json:"labels,omitempty"`
}

Config holds summary plugin settings.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL