section

type AssemblyError ¶

type AssemblyError struct {
	PRNumber int
	PRURL    string
	Reason   string
}

type CustomerImpact ¶

type CustomerImpact int

CustomerImpact mirrors the changelog contract's discrete impact values. Explicit "Customer impact omitted" differs from Customer impact: none; use ImpactPresent and/or ImpactRaw alongside the enum (ImpactNone mirrors none but is ambiguous when ImpactPresent is false).

const (
	ImpactNone CustomerImpact = iota
	ImpactFix
	ImpactEnhancement
	ImpactBreaking
)

func ParseCustomerImpact(s string) (CustomerImpact, bool)

func (i CustomerImpact) MarshalJSON() ([]byte, error)

func (i CustomerImpact) RequiresSummary() bool

func (i CustomerImpact) String() string

func (i *CustomerImpact) UnmarshalJSON(data []byte) error

type ExcludedPR ¶

type ExcludedPR struct {
	PRNumber        int
	PRURL           string
	Reason          string
	BreakingChanges *string
}

type IncludedPR ¶

type IncludedPR struct {
	PRNumber        int
	PRURL           string
	Summary         string
	BreakingChanges *string
}

type MergedPR ¶

type MergedPR struct {
	Number         int
	Title          string
	URL            string
	Labels         []string
	Body           string
	MergeCommitSHA string
	AuthorLogin    string
}

type RenderOpts ¶

type RenderOpts struct {
	PRNumber int
	PRURL    string
}

RenderOpts selects PR metadata rendered into CHANGELOG citations.

changelog-renderer.js currently only consumes PR number + URL for deterministic output. Additional authoring metadata (contributor attribution, changelog links, etc.) is reserved here.

type RenderResult ¶

type RenderResult struct {
	Success     bool
	SectionBody string
	Errors      []AssemblyError
	Included    []IncludedPR
	Excluded    []ExcludedPR
}

func RenderChangelogSection(merged []MergedPR) RenderResult

type Section ¶

type Section struct {
	CustomerImpact CustomerImpact `json:"customer_impact"`

	ImpactPresent bool `json:"impact_present,omitempty"`

	// ImpactRaw mirrors parseChangelogSection's trimmed customerImpact string (empty means missing capture).
	ImpactRaw string `json:"impact_raw,omitempty"`

	Summary                string `json:"summary,omitempty"`
	BreakingChanges        string `json:"breaking_changes,omitempty"`
	BreakingHeadingPresent bool   `json:"breaking_heading_present"`

	Raw string `json:"raw"`
}

Section is the canonical parsed representation of a PR body's ## Changelog section.

func Parse(body []byte) (Section, error)

type ValidateOpts ¶

type ValidateOpts struct {
	RelaxBreakingImpactMatch bool
}

ValidateOpts configures validateChangelogSectionFull parity checks.

By default (zero value), JS parity treats rule C ("### Breaking changes is only allowed when Customer impact: breaking...") as enabled, matching `{ enforceBreakingImpactMatch: true }` in validateChangelogSectionFull.

Set RelaxBreakingImpactMatch to replicate changelog-renderer.js release-time rendering, which disables that check via `{ enforceBreakingImpactMatch: false }`.