git

package module

v0.0.0-...-033ac90 Latest Latest Go to latest Published: Feb 2, 2023 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/scraswell/versioning

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Contains(s []string, str string) bool
func FindBumps(repositoryPath string, branch string) map[string][]*Bump
func FindModules(startingDirectory string) []string
func GetTag(moduleRelativePath string, bump *Bump) string
func GetVersionBumpRegexp() *regexp.Regexp
func IncrementMajor(version *semver.Version) *semver.Version
func IncrementMinor(version *semver.Version) *semver.Version
func IncrementPatch(version *semver.Version) *semver.Version
func MakeVersion(version string) semver.Version
func Open(repositoryPath string) *git.Repository
func Reverse[S ~[]E, E any](s S)
type Bump
type Config
type VersionBumpStrings

Constants ¶

View Source

const BumpPattern = `\b(((\w+\/?)+)__SEPARATOR__(__MAJOR__|__MINOR__|__PATCH__))\b`

View Source

const BumpTypeMajor = "major"

View Source

const BumpTypeMinor = "minor"

View Source

const BumpTypePatch = "patch"

View Source

const BumpTypeSubmatchIndex = 4

View Source

const DefaultVersion = "0.0.0"

View Source

const GoModule = "go.mod"

View Source

const ModuleSubmatchIndex = 2

Variables ¶

This section is empty.

Functions ¶

func Contains ¶

func Contains(s []string, str string) bool

checks if a string is contained within a slice of strings

func FindBumps ¶

func FindBumps(repositoryPath string, branch string) map[string][]*Bump

func FindModules ¶

func FindModules(startingDirectory string) []string

func GetTag ¶

func GetTag(moduleRelativePath string, bump *Bump) string

func GetVersionBumpRegexp ¶

func GetVersionBumpRegexp() *regexp.Regexp

func IncrementMajor ¶

func IncrementMajor(version *semver.Version) *semver.Version

func IncrementMinor ¶

func IncrementMinor(version *semver.Version) *semver.Version

func IncrementPatch ¶

func IncrementPatch(version *semver.Version) *semver.Version

func MakeVersion ¶

func MakeVersion(version string) semver.Version

func Open ¶

func Open(repositoryPath string) *git.Repository

func Reverse ¶

func Reverse[S ~[]E, E any](s S)

reverses a slice

Types ¶

type Bump ¶

type Bump struct {
	Type    string
	Commit  string
	Version semver.Version
}

type Config ¶

type Config struct {
	BumpStrings      *VersionBumpStrings `mapstructure:"bumpStrings"`
	VersionSeparator string              `mapstructure:"versionSeparator"`
}

type VersionBumpStrings ¶

type VersionBumpStrings struct {
	Major []string `mapstructure:"major"`
	Minor []string `mapstructure:"minor"`
	Patch []string `mapstructure:"patch"`
}

Source Files ¶

View all Source files

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