github/git-sv
0
0
Fork 0
mirror of https://github.com/thegeeklab/git-sv.git synced 2024-11-09 16:00:40 +00:00
Code Issues Releases Activity

docs: add environment variables on readme

Browse Source
This commit is contained in:
Beatriz Vieira 2019-12-04 21:10:16 -03:00
parent 464bbe4f52
commit 974c9275da
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -6,9 +6,23 @@ Semantic version for git
### Installing
Download the latest release and add the binary on your path
download the latest release and add the binary on your path
## Running
### 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
@ -16,7 +30,7 @@ run `git-sv` to get the list of available parameters
git-sv
```
### Run as git command
#### Run as git command
if `git-sv` is configured on your path, you can use it like a git command
@ -26,7 +40,7 @@ git sv current-version
git sv next-version
```
### Usage
#### Usage
```bash
NAME: