0
0
mirror of https://github.com/thegeeklab/git-sv.git synced 2024-11-24 11:10:39 +00:00
Semantic versioning tool for git based on conventional commits
Go to file
2019-12-04 20:57:05 -03:00
cmd/git-sv feat: add version on command usage 2019-12-04 20:18:38 -03:00
sv fix: git tag command 2019-12-04 19:50:02 -03:00
.gitignore build: ignore bin dir 2019-11-17 13:06:44 -03:00
go.mod feat: add support for current-version, next-version, commit-log and release-notes 2019-11-17 13:17:24 -03:00
go.sum feat: add support for current-version, next-version, commit-log and release-notes 2019-11-17 13:17:24 -03:00
LICENSE Initial commit 2019-11-17 12:42:31 -03:00
Makefile build: add release and release-all on makefile 2019-12-04 20:46:22 -03:00
README.md docs: add usage on docs 2019-12-04 20:57:05 -03:00

sv4git

Semantic version for git

Getting Started

Installing

Download the latest release and add the binary on your path

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"