config

package
v1.15.0 Latest Latest
Warning

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

Go to latest
Published: Feb 22, 2022 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Bump

type Bump struct {
	File   string `yaml:"file"`
	Regex  string `yaml:"regex"`
	Count  int    `yaml:"count"`
	SemVer bool   `yaml:"semver"`
}

Bump defines configuration for bumping individual files based on the new calculated semantic version number

type Changelog added in v1.11.0

type Changelog struct {
	Sort    string   `yaml:"sort"`
	Exclude []string `yaml:"exclude"`
}

Changelog defines configuration for generating a changelog of the latest semantic version based release

type CommitAuthor added in v0.4.0

type CommitAuthor struct {
	Name  string `yaml:"name"`
	Email string `yaml:"email"`
}

CommitAuthor defines configuration about the author of a git commit

type Uplift

type Uplift struct {
	FirstVersion  string       `yaml:"firstVersion"`
	Bumps         []Bump       `yaml:"bumps"`
	CommitMessage string       `yaml:"commitMessage"`
	CommitAuthor  CommitAuthor `yaml:"commitAuthor"`
	AnnotatedTags bool         `yaml:"annotatedTags"`
	Changelog     Changelog    `yaml:"changelog"`
}

Uplift defines the root configuration of the application

func Load

func Load(f string) (Uplift, error)

Load the YAML config file

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL