sv

package

Go to main page

Versions in this module

v2

v2.9.0

Jan 23, 2023

v2.8.1

Jul 22, 2022

v2.8.0

Apr 8, 2022

Changes in this version

type CommitMessageConfig

+ HeaderSelector string

type TagConfig

+ Filter string

v2.7.0

Mar 1, 2022

Changes in this version

+ const ReleaseNotesSectionTypeBreakingChanges

+ const ReleaseNotesSectionTypeCommits

type GitCommitLog

+ AuthorName string

+ Timestamp int

type ReleaseNote

+ AuthorsNames map[string]struct{}

+ type ReleaseNoteBreakingChangeSection struct

+ Messages []string

+ Name string

+ func (ReleaseNoteBreakingChangeSection) SectionType() string

+ func (s ReleaseNoteBreakingChangeSection) SectionName() string

+ type ReleaseNoteCommitsSection struct

+ Items []GitCommitLog

+ Name string

+ Types []string

+ func (ReleaseNoteCommitsSection) SectionType() string

+ func (s ReleaseNoteCommitsSection) HasMultipleTypes() bool

+ func (s ReleaseNoteCommitsSection) SectionName() string

type ReleaseNoteSection

+ SectionName func() string

+ SectionType func() string

type ReleaseNotesConfig

+ Sections []ReleaseNotesSectionConfig

+ type ReleaseNotesSectionConfig struct

+ CommitTypes []string

+ Name string

+ SectionType string

v2.6.0

Jan 29, 2022

Changes in this version

+ func IsValidVersion(value string) bool

type ReleaseNote

+ Tag string

v2.5.0

Sep 24, 2021

v2.4.0

Jul 31, 2021

Changes in this version

+ func ToVersion(value string) (semver.Version, error)

+ type BranchesConfig struct

+ DisableIssue bool

+ Prefix string

+ Skip []string

+ SkipDetached *bool

+ Suffix string

+ type BreakingChangeSection struct

+ Messages []string

+ Name string

+ type CommitMessage struct

+ Body string

+ Description string

+ IsBreakingChange bool

+ Metadata map[string]string

+ Scope string

+ Type string

+ func NewCommitMessage(ctype, scope, description, body, issue, breakingChanges string) CommitMessage

+ func (m CommitMessage) BreakingMessage() string

+ func (m CommitMessage) Issue() string

+ type CommitMessageConfig struct

+ Footer map[string]CommitMessageFooterConfig

+ Issue CommitMessageIssueConfig

+ Scope CommitMessageScopeConfig

+ Types []string

+ func (c CommitMessageConfig) IssueFooterConfig() CommitMessageFooterConfig

+ type CommitMessageFooterConfig struct

+ AddValuePrefix string

+ Key string

+ KeySynonyms []string

+ UseHash bool

+ type CommitMessageIssueConfig struct

+ Regex string

+ type CommitMessageScopeConfig struct

+ Values []string

+ type Git interface

+ Branch func() string

+ Commit func(header, body, footer string) error

+ IsDetached func() (bool, error)

+ LastTag func() string

+ Log func(lr LogRange) ([]GitCommitLog, error)

+ Tag func(version semver.Version) error

+ Tags func() ([]GitTag, error)

+ type GitCommitLog struct

+ Date string

+ Hash string

+ Message CommitMessage

+ type GitImpl struct

+ func NewGit(messageProcessor MessageProcessor, cfg TagConfig) *GitImpl

+ func (GitImpl) Branch() string

+ func (GitImpl) IsDetached() (bool, error)

+ func (GitImpl) LastTag() string

+ func (g GitImpl) Commit(header, body, footer string) error

+ func (g GitImpl) Log(lr LogRange) ([]GitCommitLog, error)

+ func (g GitImpl) Tag(version semver.Version) error

+ func (g GitImpl) Tags() ([]GitTag, error)

+ type GitTag struct

+ Date time.Time

+ Name string

+ type LogRange struct

+ func NewLogRange(t LogRangeType, start, end string) LogRange

+ type LogRangeType string

+ const DateRange

+ const HashRange

+ const TagRange

+ type MessageProcessor interface

+ Enhance func(branch string, message string) (string, error)

+ Format func(msg CommitMessage) (string, string, string)

+ IssueID func(branch string) (string, error)

+ Parse func(subject, body string) CommitMessage

+ SkipBranch func(branch string, detached bool) bool

+ Validate func(message string) error

+ ValidateDescription func(description string) error

+ ValidateScope func(scope string) error

+ ValidateType func(ctype string) error

+ type MessageProcessorImpl struct

+ func NewMessageProcessor(mcfg CommitMessageConfig, bcfg BranchesConfig) *MessageProcessorImpl

+ func (p MessageProcessorImpl) Enhance(branch string, message string) (string, error)

+ func (p MessageProcessorImpl) Format(msg CommitMessage) (string, string, string)

+ func (p MessageProcessorImpl) IssueID(branch string) (string, error)

+ func (p MessageProcessorImpl) Parse(subject, body string) CommitMessage

+ func (p MessageProcessorImpl) SkipBranch(branch string, detached bool) bool

+ func (p MessageProcessorImpl) Validate(message string) error

+ func (p MessageProcessorImpl) ValidateDescription(description string) error

+ func (p MessageProcessorImpl) ValidateScope(scope string) error

+ func (p MessageProcessorImpl) ValidateType(ctype string) error

+ type OutputFormatter interface

+ FormatChangelog func(releasenotes []ReleaseNote) (string, error)

+ FormatReleaseNote func(releasenote ReleaseNote) (string, error)

+ type OutputFormatterImpl struct

+ func NewOutputFormatter() *OutputFormatterImpl

+ func (p OutputFormatterImpl) FormatChangelog(releasenotes []ReleaseNote) (string, error)

+ func (p OutputFormatterImpl) FormatReleaseNote(releasenote ReleaseNote) (string, error)

+ type ReleaseNote struct

+ BreakingChanges BreakingChangeSection

+ Date time.Time

+ Sections map[string]ReleaseNoteSection

+ Version *semver.Version

+ type ReleaseNoteProcessor interface

+ Create func(version *semver.Version, date time.Time, commits []GitCommitLog) ReleaseNote

+ type ReleaseNoteProcessorImpl struct

+ func NewReleaseNoteProcessor(cfg ReleaseNotesConfig) *ReleaseNoteProcessorImpl

+ func (p ReleaseNoteProcessorImpl) Create(version *semver.Version, date time.Time, commits []GitCommitLog) ReleaseNote

+ type ReleaseNoteSection struct

+ Items []GitCommitLog

+ Name string

+ type ReleaseNotesConfig struct

+ Headers map[string]string

+ type SemVerCommitsProcessor interface

+ NextVersion func(version semver.Version, commits []GitCommitLog) (semver.Version, bool)

+ type SemVerCommitsProcessorImpl struct

+ IncludeUnknownTypeAsPatch bool

+ KnownTypes []string

+ MajorVersionTypes map[string]struct{}

+ MinorVersionTypes map[string]struct{}

+ PatchVersionTypes map[string]struct{}

+ func NewSemVerCommitsProcessor(vcfg VersioningConfig, mcfg CommitMessageConfig) *SemVerCommitsProcessorImpl

+ func (p SemVerCommitsProcessorImpl) NextVersion(version semver.Version, commits []GitCommitLog) (semver.Version, bool)

+ type TagConfig struct

+ Pattern string

+ type VersioningConfig struct

+ IgnoreUnknown bool

+ UpdateMajor []string

+ UpdateMinor []string

+ UpdatePatch []string

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