releaser

Documentation

Overview

Package releaser is used for releasing to Github or Gitlab Releases.

Index

• type Options
• type Provider
• type Releaser
  • func CreateReleaser(options Options) (*Releaser, error)
  • func (r *Releaser) Release(releaseNotes string) error
• type Service

Types

type Options

type Options struct {
	Provider Provider
	Token    string
	Owner    string
	Repo     string
	// used for setting gitlab api url
	APIURL string
	// used by gitlab
	TagName string
	// used by Gitlab
	ProjectID int
}

Options are used to initialize releaser

type Provider

type Provider string

Provider refers to git service provider such as Gitlab/Github

const (
	// Github sets Releaser to use Github specific commands
	Github Provider = "github"
	// Gitlab sets Releaser to use Gitlab specific commands
	Gitlab Provider = "gitlab"
)

type Releaser

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

Releaser holds all functionality related to releasing.

func CreateReleaser

func CreateReleaser(options Options) (*Releaser, error)

CreateReleaser initializes an instance of Releaser

func (*Releaser) Release

func (r *Releaser) Release(releaseNotes string) error

Release pulls latest tag and its text, then it appends passed release notes

type Service

type Service interface {
	LatestRelease() (*release.Release, error)
	Publish(*release.Release) error
}

Service describes the basic usage needed from a service such as Github