github

Documentation

Index

• func ParseGithubURL(githubURL string) (username, projectName string, err error)
• type Release
  • func NewRelease(config *config.Config, args []string, spinner *yacspin.Spinner) (*Release, error)
  • func (r *Release) CreateGithubRelease(tokenFile, binaryPath string, spinner *yacspin.Spinner) error

Functions

func ParseGithubURL

func ParseGithubURL(githubURL string) (username, projectName string, err error)

ParseGithubURL parses the githubURL and return a username and repo name

Types

type Release

type Release struct {
	User        string
	Date        string // date in format: month day, year
	Changelog   []byte
	Repository  string // full repository name from config
	ProjectName string // the project name grabbed from the repository
	Version     string // semver without the v; ex: 1.0.0
	VersionFull string // ex: <semver>_<epoch>_<commit>
	Commands    map[string][]string
}

Release contains information pertaining to a specific github release

func NewRelease

func NewRelease(config *config.Config, args []string, spinner *yacspin.Spinner) (*Release, error)

NewRelease creates a prepopulated release struct using the config file and other sources

func (*Release) CreateGithubRelease

func (r *Release) CreateGithubRelease(tokenFile, binaryPath string, spinner *yacspin.Spinner) error

CreateGithubRelease cuts a new release, tags the current commit with semver, and uploads the changelog as a description