gitmono

README

gitmono

CLI tool that wraps git to manage versioning of projects in monorepos.

All commands accept the monorepo project to operate on, using the -p flag. When none is specified, the flag defaults to . that enables the tool for any repository type (also non-monorepo). The specified project should match the subdirectory of the project from the root path.

Commands

init command releases and prints the initial version (0.1.0) for the specified project, if it has never been released.

version command prints the latest version of the specified project.

release command releases and prints a new version of the specified project, after looking up for a version bump command in the commits that reference files of that project.

diff command prints out the modified files for the specified git reference range that match the project subdirectory.

log command prints out the commits for the specified git reference range that match project subdirectory.

Examples

Initialise versioning:

gitmono init -p mod1

0.1.0

Get version:

gitmono version -p mod1

0.1.0

Release version:

gitmono release -p mod1

mod1/0.2.0

Diff modified files:

gitmono diff -p mod1 -f head~1 -t head

mod1/go.mod

Get commit log:

gitmono log -p mod1 -f head~2 -t head

7fd4cd0d6141b3cbc3c4f0a2206090140d2d7722 fix: mod1 modified

Documentation

Index

• func GetProjectTagPrefix(project string) string
• type Bumper
• type CommitParser
• type Config
• type Differ
• type EnvVars
• type GitDiffer
• type GitLogger
• type GitTagger
• type Logger
• type Tagger
• type VersionedCommit
  • func (vc *VersionedCommit) GetTag() string
  • func (vc *VersionedCommit) GetVersion() string
• type Versioner

Functions

func GetProjectTagPrefix

func GetProjectTagPrefix(project string) string

GetProjectTagPrefix calculates the project tag prefix for the specified project value

Types

type Bumper

type Bumper interface {
	Bump(*version.Version) (*version.Version, error)
}

Bumper bumps a version to a new version

Bump calculates a new version by incrementing (bumping) a version

type CommitParser

type CommitParser interface {
	GetBumperFromCommit(*git.Commit) Bumper
}

CommitParser parses the provided commit

GetBumperFromCommit parses a commit message and decide the bumper to use for version

type Config

type Config struct {
	DryRun        bool
	CommitScheme  string
	VersionPrefix string
	Project       string
}

Config defines generic configuration applying to multiple commands

type Differ

type Differ interface {
	Diff(from, to string) ([]string, error)
}

Differ performs diff on the repo

Diff two git references and retuns a list of modified files

type EnvVars

type EnvVars struct {
	CommitterName  string
	CommitterEmail string
	GitRepoPath    string
}

EnvVars contains the accepted environment variables

type GitDiffer

type GitDiffer interface {
	Diff(rev string, maxFiles, maxFileLines, maxLineChars int, opts ...git.DiffOptions) (*git.Diff, error)
}

GitDiffer abstracts git diff operations

type GitLogger

type GitLogger interface {
	Log(rev string, opts ...git.LogOptions) ([]*git.Commit, error)
	CommitByRevision(rev string, opts ...git.CommitByRevisionOptions) (*git.Commit, error)
}

GitLogger abstracts git log operations

type GitTagger

type GitTagger interface {
	Tags(opts ...git.TagsOptions) ([]string, error)
	CreateTag(name, rev string, opts ...git.CreateTagOptions) error
}

GitTagger abstracts git tag operations

type Logger

type Logger interface {
	Log(from, to string) ([]*git.Commit, error)
	CommitHashByRevision(rev string) (string, error)
}

Logger performs log commands on the repo

Log returns the commits for the specified reference range in reverse chronological order CommitHashByRevision returns the commit hash matching to a revision

type Tagger

type Tagger interface {
	CreateTag(versionedCommit *VersionedCommit) error
	ListProjectVersionTags() ([]string, error)
}

Tagger performs tag commands on the repo

CreateTag writes the given tag to the given commit ListProjectVersionTags retrieves all tags for a project using the tag list pattern

type VersionedCommit

type VersionedCommit struct {
	CommitID      string
	Project       string
	VersionPrefix string
	Version       *version.Version
}

VersionedCommit points a commit that is assigned a version

func (*VersionedCommit) GetTag

func (vc *VersionedCommit) GetTag() string

GetTag returns the tag to version a commit with

func (*VersionedCommit) GetVersion

func (vc *VersionedCommit) GetVersion() string

GetVersion returns the version part of the tag

type Versioner

type Versioner interface {
	GetCurrentVersion() (*VersionedCommit, error)
	ReleaseNewVersion(commitID string) (*VersionedCommit, error)
	InitVersion(commitID string) (*VersionedCommit, error)
}

Versioner maintains version using tags

GetCurrentVersion retrieves the latest version ReleaseNewVersion creates and persists a new version InitVersion creates and persists the initial version