bump

README

gh bump

a gh extension for bumping version of a repository.

Usage

gh bump

with another repository.

gh bump -R <repository>

If you want to see more detail about this extension, you can run below.

gh bump -h

Installation

gh extension install johnmanjiro13/gh-bump

Documentation

Index

• Variables
• func NewBumper(gh Gh) *bumper
• func NewGh() *ghCLI
• func NewRootCmd(bumper Bumper) *cobra.Command
• type BumpType
  • func ParseBumpType(s string) (BumpType, error)
  • func (b BumpType) IsBlank() bool
  • func (b BumpType) String() string
  • func (b BumpType) Valid() error
• type Bumper
• type Gh
• type ReleaseOption

Variables

var ErrInvalidBumpType = errors.New("invalid bump type")

Functions

func NewBumper

func NewBumper(gh Gh) *bumper

func NewGh

func NewGh() *ghCLI

func NewRootCmd

func NewRootCmd(bumper Bumper) *cobra.Command

Types

type BumpType

type BumpType string

const (
	Major BumpType = "major"
	Minor BumpType = "minor"
	Patch BumpType = "patch"
	Blank BumpType = ""
)

func ParseBumpType

func ParseBumpType(s string) (BumpType, error)

func (BumpType) IsBlank

func (b BumpType) IsBlank() bool

func (BumpType) String

func (b BumpType) String() string

func (BumpType) Valid

func (b BumpType) Valid() error

type Bumper

type Bumper interface {
	Bump() error
	WithRepository(repository string) error
	WithDraft()
	WithPrerelease()
	WithDiscussionCategory(category string)
	WithGenerateNotes()
	WithNotes(notes string)
	WithNotesFile(filename string)
	WithTitle(title string)
	WithTarget(target string)
	WithBumpType(bumpType string) error
	WithYes()
}

type Gh

type Gh interface {
	ViewRepository() (sout, eout *bytes.Buffer, err error)
	ListRelease(repo string, isCurrent bool) (sout, eout *bytes.Buffer, err error)
	ViewRelease(repo string, isCurrent bool) (sout, eout *bytes.Buffer, err error)
	CreateRelease(version string, repo string, isCurrent bool, option *ReleaseOption) (sout, eout *bytes.Buffer, err error)
}

type ReleaseOption

type ReleaseOption struct {
	IsDraft            bool
	IsPrerelease       bool
	DiscussionCategory string
	GenerateNotes      bool
	Notes              string
	NotesFilename      string
	Target             string
	Title              string
}