announce

Documentation

Index

• Constants
• type Announce
  • func NewAnnounce(opts *Options) *Announce
  • func (a *Announce) CreateForBranch() error
  • func (a *Announce) CreateForRelease() error
  • func (a *Announce) SetImplementation(i impl)
• type Options
  • func NewOptions() *Options
  • func (o *Options) WithBranch(branch string) *Options
  • func (o *Options) WithChangelogFile(changelogFile string) *Options
  • func (o *Options) WithChangelogHTML(changelogHTML string) *Options
  • func (o *Options) WithChangelogPath(changelogPath string) *Options
  • func (o *Options) WithTag(tag string) *Options
  • func (o *Options) WithWorkDir(workDir string) *Options

Constants

const AnnouncementFile = "announcement.html"

AnnouncementFile is the default announcement HTML file.

Types

type Announce

type Announce struct {
	// contains filtered or unexported fields
}

func NewAnnounce

func NewAnnounce(opts *Options) *Announce

NewAnnounce returns a new Announce instance.

func (*Announce) CreateForBranch

func (a *Announce) CreateForBranch() error

func (*Announce) CreateForRelease

func (a *Announce) CreateForRelease() error

func (*Announce) SetImplementation

func (a *Announce) SetImplementation(i impl)

SetImplementation sets the implementation to handle file operations.

type Options

type Options struct {
	// contains filtered or unexported fields
}

func NewOptions

func NewOptions() *Options

NewOptions can be used to create a new Options instance.

func (*Options) WithBranch

func (o *Options) WithBranch(branch string) *Options

func (*Options) WithChangelogFile

func (o *Options) WithChangelogFile(changelogFile string) *Options

func (*Options) WithChangelogHTML

func (o *Options) WithChangelogHTML(changelogHTML string) *Options

func (*Options) WithChangelogPath

func (o *Options) WithChangelogPath(changelogPath string) *Options

func (*Options) WithTag

func (o *Options) WithTag(tag string) *Options

func (*Options) WithWorkDir

func (o *Options) WithWorkDir(workDir string) *Options