semrel

Documentation

Index

• func ApplyChange(version *semver.Version, change Change, allowInitialDevelopmentVersions bool) *semver.Version
• func GetChangelog(commits []*Commit, latestRelease *Release, newVersion *semver.Version) string
• func GetNewVersion(conf *config.Config, commits []*Commit, latestRelease *Release) *semver.Version
• type Change
  • func CalculateChange(commits []*Commit, latestRelease *Release) Change
• type Commit
• type GitHubRepository
  • func NewGitHubRepository(ctx context.Context, gheHost, slug, token string) (*GitHubRepository, error)
  • func (repo *GitHubRepository) CreateRelease(changelog string, newVersion *semver.Version, prerelease bool, ...) error
  • func (repo *GitHubRepository) GetCommits(sha string) ([]*Commit, error)
  • func (repo *GitHubRepository) GetInfo() (string, bool, error)
  • func (repo *GitHubRepository) GetLatestRelease(vrange string, re *regexp.Regexp) (*Release, error)
  • func (repo *GitHubRepository) Owner() string
  • func (repo *GitHubRepository) Provider() string
  • func (repo *GitHubRepository) Repo() string
• type GitLabRepository
  • func NewGitLabRepository(ctx context.Context, gitlabBaseUrl, slug, token, branch string, ...) (*GitLabRepository, error)
  • func (repo *GitLabRepository) CreateRelease(changelog string, newVersion *semver.Version, prerelease bool, ...) error
  • func (repo *GitLabRepository) GetCommits(sha string) ([]*Commit, error)
  • func (repo *GitLabRepository) GetInfo() (string, bool, error)
  • func (repo *GitLabRepository) GetLatestRelease(vrange string, re *regexp.Regexp) (*Release, error)
  • func (repo *GitLabRepository) Owner() string
  • func (repo *GitLabRepository) Provider() string
  • func (repo *GitLabRepository) Repo() string
• type Release
• type Releases
  • func (releases Releases) GetLatestRelease(vrange string) (*Release, error)
  • func (r Releases) Len() int
  • func (r Releases) Less(i, j int) bool
  • func (r Releases) Swap(i, j int)
• type Repository

Functions

func ApplyChange

func ApplyChange(version *semver.Version, change Change, allowInitialDevelopmentVersions bool) *semver.Version

func GetChangelog

func GetChangelog(commits []*Commit, latestRelease *Release, newVersion *semver.Version) string

func GetNewVersion

func GetNewVersion(conf *config.Config, commits []*Commit, latestRelease *Release) *semver.Version

Types

type Change

type Change struct {
	Major, Minor, Patch bool
}

func CalculateChange

func CalculateChange(commits []*Commit, latestRelease *Release) Change

type Commit

type Commit struct {
	SHA     string
	Raw     []string
	Type    string
	Scope   string
	Message string
	Change  Change
}

type GitHubRepository

type GitHubRepository struct {
	Ctx    context.Context
	Client *github.Client
	// contains filtered or unexported fields
}

func NewGitHubRepository

func NewGitHubRepository(ctx context.Context, gheHost, slug, token string) (*GitHubRepository, error)

func (*GitHubRepository) CreateRelease

func (repo *GitHubRepository) CreateRelease(changelog string, newVersion *semver.Version, prerelease bool, branch, sha string) error

func (*GitHubRepository) GetCommits

func (repo *GitHubRepository) GetCommits(sha string) ([]*Commit, error)

func (*GitHubRepository) GetInfo

func (repo *GitHubRepository) GetInfo() (string, bool, error)

func (*GitHubRepository) GetLatestRelease

func (repo *GitHubRepository) GetLatestRelease(vrange string, re *regexp.Regexp) (*Release, error)

func (*GitHubRepository) Owner

func (repo *GitHubRepository) Owner() string

func (*GitHubRepository) Provider

func (repo *GitHubRepository) Provider() string

func (*GitHubRepository) Repo

func (repo *GitHubRepository) Repo() string

type GitLabRepository

type GitLabRepository struct {
	Ctx context.Context
	// contains filtered or unexported fields
}

func NewGitLabRepository

func NewGitLabRepository(ctx context.Context, gitlabBaseUrl, slug, token, branch string, projectID string) (*GitLabRepository, error)

func (*GitLabRepository) CreateRelease

func (repo *GitLabRepository) CreateRelease(changelog string, newVersion *semver.Version, prerelease bool, branch, sha string) error

func (*GitLabRepository) GetCommits

func (repo *GitLabRepository) GetCommits(sha string) ([]*Commit, error)

func (*GitLabRepository) GetInfo

func (repo *GitLabRepository) GetInfo() (string, bool, error)

func (*GitLabRepository) GetLatestRelease

func (repo *GitLabRepository) GetLatestRelease(vrange string, re *regexp.Regexp) (*Release, error)

func (*GitLabRepository) Owner

func (repo *GitLabRepository) Owner() string

func (*GitLabRepository) Provider

func (repo *GitLabRepository) Provider() string

func (*GitLabRepository) Repo

func (repo *GitLabRepository) Repo() string

type Release

type Release struct {
	SHA     string
	Version *semver.Version
}

type Releases

type Releases []*Release

func (Releases) GetLatestRelease

func (releases Releases) GetLatestRelease(vrange string) (*Release, error)

func (Releases) Len

func (r Releases) Len() int

func (Releases) Less

func (r Releases) Less(i, j int) bool

func (Releases) Swap

func (r Releases) Swap(i, j int)

type Repository

type Repository interface {
	GetInfo() (string, bool, error)
	GetCommits(sha string) ([]*Commit, error)
	GetLatestRelease(vrange string, re *regexp.Regexp) (*Release, error)
	CreateRelease(changelog string, newVersion *semver.Version, prerelease bool, branch, sha string) error
	Owner() string
	Repo() string
	Provider() string
}