1
0
Fork 0
git-sv/README.md
2019-12-04 21:10:16 -03:00

2.4 KiB

sv4git

Semantic version for git

Getting Started

Installing

download the latest release and add the binary on your path

Config

you can config using the environment variables

Variable description default
MAJOR_VERSION_TYPES types used to bump major version
MINOR_VERSION_TYPES types used to bump minor version feat
PATCH_VERSION_TYPES types used to bump patch version build,ci,docs,fix,perf,refactor,style,test
INCLUDE_UNKNOWN_TYPE_AS_PATCH force patch bump on unknown type true
COMMIT_MESSAGE_METADATA metadata format on commit message breakingchange:BREAKING CHANGE,issueid:jira
TAG_PATTERN tag version pattern %d.%d.%d
RELEASE_NOTES_TAGS release notes headers for each visible type fix:Bug Fixes,feat:Features

Running

run git-sv to get the list of available parameters

git-sv

Run as git command

if git-sv is configured on your path, you can use it like a git command

git sv
git sv current-version
git sv next-version

Usage

NAME:
   sv - semantic version for git

USAGE:
   git-sv [global options] command [command options] [arguments...]

VERSION:
   1.0.0

COMMANDS:
   current-version, cv  get last released version from git
   next-version, nv     generate the next version based on git commit messages
   commit-log, cl       list all commit logs since last version as jsons
   release-notes, rn    generate release notes
   tag, tg              generate tag with version based on git commit messages
   help, h              Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

Development

Makefile

run make to get the list of available actions

make

Make configs

Variable description
BUILDOS build OS
BUILDARCH build arch
ECHOFLAGS flags used on echo
BUILDENVS var envs used on build
BUILDFLAGS flags used on build
Parameters description
args parameters that will be used on run
#variables
BUILDOS="linux" BUILDARCH="amd64" make build

#parameters
make run args="-h"

Build

make build

the binary will be created on bin/$BUILDOS_$BUILDARCH/git-sv

Tests

make test

Run

#without args
make run

#with args
make run args="-h"