Help us shape the future of Go! Take the 2026 Go Developer Survey

changelog

package
v0.57.21 Latest Latest
Warning

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

 Go to latest Published: Oct 2, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RenderReleaseMarkdown 

func RenderReleaseMarkdown(cl *Changelog, version string) (string, error)

RenderReleaseMarkdown renders one release as GitHub release-note markdown.

Types

type ChangeEntry 

type ChangeEntry struct {

	// description is the user-facing description.
	Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	// description_markdown is the display-ready markdown description.
	DescriptionMarkdown string `protobuf:"bytes,2,opt,name=description_markdown,json=descriptionMarkdown,proto3" json:"descriptionMarkdown,omitempty"`
	// contains filtered or unexported fields
}

ChangeEntry is a single changelog entry.

func (*ChangeEntry) CloneMessageVT 

func (m *ChangeEntry) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*ChangeEntry) CloneVT 

func (m *ChangeEntry) CloneVT() *ChangeEntry

func (*ChangeEntry) EqualMessageVT 

func (this *ChangeEntry) EqualMessageVT(thatMsg any) bool

func (*ChangeEntry) EqualVT 

func (this *ChangeEntry) EqualVT(that *ChangeEntry) bool

func (*ChangeEntry) GetDescription 

func (x *ChangeEntry) GetDescription() string

func (*ChangeEntry) GetDescriptionMarkdown 

func (x *ChangeEntry) GetDescriptionMarkdown() string

func (*ChangeEntry) MarshalJSON 

func (x *ChangeEntry) MarshalJSON() ([]byte, error)

MarshalJSON marshals the ChangeEntry to JSON.

func (*ChangeEntry) MarshalProtoJSON 

func (x *ChangeEntry) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the ChangeEntry message to JSON.

func (*ChangeEntry) MarshalProtoText 

func (x *ChangeEntry) MarshalProtoText() string

func (*ChangeEntry) MarshalToSizedBufferVT 

func (m *ChangeEntry) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*ChangeEntry) MarshalToVT 

func (m *ChangeEntry) MarshalToVT(dAtA []byte) (int, error)

func (*ChangeEntry) MarshalVT 

func (m *ChangeEntry) MarshalVT() (dAtA []byte, err error)

func (*ChangeEntry) ProtoMessage 

func (*ChangeEntry) ProtoMessage()

func (*ChangeEntry) Reset 

func (x *ChangeEntry) Reset()

func (*ChangeEntry) SizeVT 

func (m *ChangeEntry) SizeVT() (n int)

func (*ChangeEntry) String 

func (x *ChangeEntry) String() string

func (*ChangeEntry) UnmarshalJSON 

func (x *ChangeEntry) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the ChangeEntry from JSON.

func (*ChangeEntry) UnmarshalProtoJSON 

func (x *ChangeEntry) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the ChangeEntry message from JSON.

func (*ChangeEntry) UnmarshalVT 

func (m *ChangeEntry) UnmarshalVT(dAtA []byte) error

func (*ChangeEntry) Validate 

func (e *ChangeEntry) Validate() error

Validate checks the user-facing change entry fields.

type Changelog 

type Changelog struct {

	// releases is the list of releases, newest first.
	Releases []*Release `protobuf:"bytes,1,rep,name=releases,proto3" json:"releases,omitempty"`
	// contains filtered or unexported fields
}

Changelog contains all release entries.

func GetChangelog 

func GetChangelog() (*Changelog, error)

GetChangelog returns the embedded changelog.

func ParseOrgChangelog 

func ParseOrgChangelog(data []byte) (*Changelog, error)

ParseOrgChangelog parses the constrained CHANGELOG.org subset.

func (*Changelog) CloneMessageVT 

func (m *Changelog) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Changelog) CloneVT 

func (m *Changelog) CloneVT() *Changelog

func (*Changelog) EqualMessageVT 

func (this *Changelog) EqualMessageVT(thatMsg any) bool

func (*Changelog) EqualVT 

func (this *Changelog) EqualVT(that *Changelog) bool

func (*Changelog) GetReleases 

func (x *Changelog) GetReleases() []*Release

func (*Changelog) MarshalJSON 

func (x *Changelog) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Changelog to JSON.

func (*Changelog) MarshalProtoJSON 

func (x *Changelog) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the Changelog message to JSON.

func (*Changelog) MarshalProtoText 

func (x *Changelog) MarshalProtoText() string

func (*Changelog) MarshalToSizedBufferVT 

func (m *Changelog) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Changelog) MarshalToVT 

func (m *Changelog) MarshalToVT(dAtA []byte) (int, error)

func (*Changelog) MarshalVT 

func (m *Changelog) MarshalVT() (dAtA []byte, err error)

func (*Changelog) ProtoMessage 

func (*Changelog) ProtoMessage()

func (*Changelog) Reset 

func (x *Changelog) Reset()

func (*Changelog) SizeVT 

func (m *Changelog) SizeVT() (n int)

func (*Changelog) String 

func (x *Changelog) String() string

func (*Changelog) UnmarshalJSON 

func (x *Changelog) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Changelog from JSON.

func (*Changelog) UnmarshalProtoJSON 

func (x *Changelog) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the Changelog message from JSON.

func (*Changelog) UnmarshalVT 

func (m *Changelog) UnmarshalVT(dAtA []byte) error

func (*Changelog) Validate 

func (c *Changelog) Validate() error

Validate checks the changelog for the constrained release-note invariants.

type Release 

type Release struct {

	// version is the semver version string (e.g. "0.1.0").
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// date is the release date in YYYY-MM-DD format.
	Date string `protobuf:"bytes,2,opt,name=date,proto3" json:"date,omitempty"`
	// summary is a 1-2 sentence summary of the release.
	Summary string `protobuf:"bytes,3,opt,name=summary,proto3" json:"summary,omitempty"`
	// summary_markdown is the display-ready markdown summary.
	SummaryMarkdown string `protobuf:"bytes,4,opt,name=summary_markdown,json=summaryMarkdown,proto3" json:"summaryMarkdown,omitempty"`
	// features is the list of new feature entries.
	Features []*ChangeEntry `protobuf:"bytes,5,rep,name=features,proto3" json:"features,omitempty"`
	// fixes is the list of bug fix entries.
	Fixes []*ChangeEntry `protobuf:"bytes,6,rep,name=fixes,proto3" json:"fixes,omitempty"`
	// improvements is the list of improvement entries.
	Improvements []*ChangeEntry `protobuf:"bytes,7,rep,name=improvements,proto3" json:"improvements,omitempty"`
	// security is the list of security-related entries.
	Security []*ChangeEntry `protobuf:"bytes,8,rep,name=security,proto3" json:"security,omitempty"`
	// release_url is an optional public release URL.
	ReleaseUrl string `protobuf:"bytes,9,opt,name=release_url,json=releaseUrl,proto3" json:"releaseUrl,omitempty"`
	// contains filtered or unexported fields
}

Release is a single versioned release.

func (*Release) CloneMessageVT 

func (m *Release) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Release) CloneVT 

func (m *Release) CloneVT() *Release

func (*Release) EqualMessageVT 

func (this *Release) EqualMessageVT(thatMsg any) bool

func (*Release) EqualVT 

func (this *Release) EqualVT(that *Release) bool

func (*Release) GetDate 

func (x *Release) GetDate() string

func (*Release) GetFeatures 

func (x *Release) GetFeatures() []*ChangeEntry

func (*Release) GetFixes 

func (x *Release) GetFixes() []*ChangeEntry

func (*Release) GetImprovements 

func (x *Release) GetImprovements() []*ChangeEntry

func (*Release) GetReleaseUrl 

func (x *Release) GetReleaseUrl() string

func (*Release) GetSecurity 

func (x *Release) GetSecurity() []*ChangeEntry

func (*Release) GetSummary 

func (x *Release) GetSummary() string

func (*Release) GetSummaryMarkdown 

func (x *Release) GetSummaryMarkdown() string

func (*Release) GetVersion 

func (x *Release) GetVersion() string

func (*Release) MarshalJSON 

func (x *Release) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Release to JSON.

func (*Release) MarshalProtoJSON 

func (x *Release) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the Release message to JSON.

func (*Release) MarshalProtoText 

func (x *Release) MarshalProtoText() string

func (*Release) MarshalToSizedBufferVT 

func (m *Release) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Release) MarshalToVT 

func (m *Release) MarshalToVT(dAtA []byte) (int, error)

func (*Release) MarshalVT 

func (m *Release) MarshalVT() (dAtA []byte, err error)

func (*Release) ProtoMessage 

func (*Release) ProtoMessage()

func (*Release) Reset 

func (x *Release) Reset()

func (*Release) SizeVT 

func (m *Release) SizeVT() (n int)

func (*Release) String 

func (x *Release) String() string

func (*Release) UnmarshalJSON 

func (x *Release) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Release from JSON.

func (*Release) UnmarshalProtoJSON 

func (x *Release) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the Release message from JSON.

func (*Release) UnmarshalVT 

func (m *Release) UnmarshalVT(dAtA []byte) error

func (*Release) Validate 

func (r *Release) Validate() error

Validate checks the release for required user-facing fields.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.