Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Changelog ¶
type Changelog struct {
Version string
Additions []ChangelogEntry
Changes []ChangelogEntry
Removals []ChangelogEntry
Deprecations []ChangelogEntry
Bugfixes []ChangelogEntry
Repo string
}
func ChangelogFromEntries ¶
func ChangelogFromEntries(version semver.Version, entries []FragmentEntry) Changelog
type ChangelogEntry ¶
type EntryMigration ¶
func (EntryMigration) Validate ¶
func (m EntryMigration) Validate() error
type Fragment ¶
type Fragment struct {
Entries []FragmentEntry `yaml:"entries"`
}
type FragmentEntry ¶
type FragmentEntry struct {
Description string `json:"description"`
Kind EntryKind `json:"kind"`
Breaking bool `json:"breaking"`
Migration *EntryMigration `json:"migration,omitempty"`
PullRequest *uint `json:"pull_request_override,omitempty"`
PullRequestLink string `json:"-"`
}
func LoadEntries ¶
func LoadEntries(fragmentsDir, repo string) ([]FragmentEntry, error)
func (*FragmentEntry) Validate ¶
func (e *FragmentEntry) Validate() error
type MigrationGuide ¶
func MigrationGuideFromEntries ¶
func MigrationGuideFromEntries(version semver.Version, entries []FragmentEntry) MigrationGuide
func (*MigrationGuide) Template ¶
func (mg *MigrationGuide) Template() ([]byte, error)
func (*MigrationGuide) WriteFile ¶
func (mg *MigrationGuide) WriteFile(path string) error
type PullRequestNumberGetter ¶
Click to show internal directories.
Click to hide internal directories.