releaser

package
v0.9.7 Latest Latest
Warning

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

 Go to latest Published: Mar 10, 2022 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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

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.