mirror of
https://github.com/thegeeklab/git-sv.git
synced 2024-11-10 02:10:38 +00:00
171 lines
8.0 KiB
Markdown
171 lines
8.0 KiB
Markdown
# 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 |
|
|
| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
|
|
| SV4GIT_MAJOR_VERSION_TYPES | types used to bump major version | |
|
|
| SV4GIT_MINOR_VERSION_TYPES | types used to bump minor version | feat |
|
|
| SV4GIT_PATCH_VERSION_TYPES | types used to bump patch version | build,ci,chore,docs,fix,perf,refactor,style,test |
|
|
| SV4GIT_INCLUDE_UNKNOWN_TYPE_AS_PATCH | force patch bump on unknown type | true |
|
|
| SV4GIT_BRAKING_CHANGE_PREFIXES | list of prefixes that will be used to identify a breaking change | BREAKING CHANGE:,BREAKING CHANGES: |
|
|
| SV4GIT_ISSUEID_PREFIXES | list of prefixes that will be used to identify an issue id | jira:,JIRA:,Jira: |
|
|
| SV4GIT_TAG_PATTERN | tag version pattern | %d.%d.%d |
|
|
| SV4GIT_RELEASE_NOTES_TAGS | release notes headers for each visible type | fix:Bug Fixes,feat:Features |
|
|
| SV4GIT_VALIDATE_MESSAGE_SKIP_BRANCHES | ignore branches from this list on validate commit message | master,develop |
|
|
| SV4GIT_COMMIT_MESSAGE_TYPES | list of valid commit types for commit message | build,ci,chore,docs,feat,fix,perf,refactor,revert,style,test |
|
|
| SV4GIT_ISSUE_KEY_NAME | metadata key name used on validate commit message hook to enhance footer, if blank footer will not be added | jira |
|
|
| SV4GIT_ISSUE_REGEX | issue id regex, if blank footer will not be added | [A-Z]+-[0-9]+ |
|
|
| SV4GIT_BRANCH_ISSUE_REGEX | regex to extract issue id from branch name, must have 3 groups (prefix, id, posfix), if blank footer will not be added | ^([a-z]+\\/)?([A-Z]+-[0-9]+)(-.*)? |
|
|
|
|
### Running
|
|
|
|
run `git-sv` to get the list of available parameters
|
|
|
|
```bash
|
|
git-sv
|
|
```
|
|
|
|
#### Run as git command
|
|
|
|
if `git-sv` is configured on your path, you can use it like a git command
|
|
|
|
```bash
|
|
git sv
|
|
git sv current-version
|
|
git sv next-version
|
|
```
|
|
|
|
#### Usage
|
|
|
|
use `--help` or `-h` to get usage information, dont forget that some commands have unique options too
|
|
|
|
```bash
|
|
# sv help
|
|
git-sv -h
|
|
|
|
# sv release-notes command help
|
|
git-sv rn -h
|
|
```
|
|
|
|
##### Available commands
|
|
|
|
| Variable | description | has options |
|
|
| ---------------------------- | ------------------------------------------------------------- | :----------------: |
|
|
| current-version, cv | get last released version from git | :x: |
|
|
| next-version, nv | generate the next version based on git commit messages | :x: |
|
|
| commit-log, cl | list all commit logs according to range as jsons | :heavy_check_mark: |
|
|
| commit-notes, cn | generate a commit notes according to range | :heavy_check_mark: |
|
|
| release-notes, rn | generate release notes | :heavy_check_mark: |
|
|
| changelog, cgl | generate changelog | :heavy_check_mark: |
|
|
| tag, tg | generate tag with version based on git commit messages | :x: |
|
|
| commit, cmt | execute git commit with convetional commit message helper | :x: |
|
|
| validate-commit-message, vcm | use as prepare-commit-message hook to validate commit message | :heavy_check_mark: |
|
|
| help, h | shows a list of commands or help for one command | :x: |
|
|
|
|
##### Use range
|
|
|
|
Commands like `commit-log` and `commit-notes` has a range option. Supported range types are: `tag`, `date` and `hash`.
|
|
|
|
By default, it's used [--date=short](https://git-scm.com/docs/git-log#Documentation/git-log.txt---dateltformatgt) at `git log`, all dates returned from it will be in `YYYY-MM-DD` format.
|
|
|
|
Range `tag` will use `git describe` to get the last tag available if `start` is empty, the others types won't use the existing tags, it's recommended to always use a start limit in a old repository with a lot of commits. This behavior was maintained to not break the retrocompatibility.
|
|
|
|
Range `date` use git log `--since` and `--until`, it's possible to use all supported formats from [git log](https://git-scm.com/docs/git-log#Documentation/git-log.txt---sinceltdategt), if `end` is in `YYYY-MM-DD` format, `sv` will add a day on git log command to make the end date inclusive.
|
|
|
|
Range `tag` and `hash` are used on git log [revision range](https://git-scm.com/docs/git-log#Documentation/git-log.txt-ltrevisionrangegt). If `end` is empty, `HEAD` will be used instead.
|
|
|
|
```bash
|
|
# get commit log as json using a inclusive range
|
|
git-sv commit-log --range hash --start 7ea9306~1 --end c444318
|
|
|
|
# return all commits after last tag
|
|
git-sv commit-log --range tag
|
|
```
|
|
|
|
##### Use validate-commit-message as prepare-commit-msg hook
|
|
|
|
Configure your .git/hooks/prepare-commit-msg
|
|
|
|
```bash
|
|
#!/bin/sh
|
|
|
|
COMMIT_MSG_FILE=$1
|
|
COMMIT_SOURCE=$2
|
|
SHA1=$3
|
|
|
|
git sv vcm --path "$(pwd)" --file $COMMIT_MSG_FILE --source $COMMIT_SOURCE
|
|
```
|
|
|
|
tip: you can configure a directory as your global git templates using the command below, check [git config docs](https://git-scm.com/docs/git-config#Documentation/git-config.txt-inittemplateDir) for more information!
|
|
|
|
```bash
|
|
git config --global init.templatedir '<YOUR TEMPLATE DIR>'
|
|
```
|
|
|
|
## Development
|
|
|
|
### Makefile
|
|
|
|
run `make` to get the list of available actions
|
|
|
|
```bash
|
|
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 |
|
|
|
|
```bash
|
|
#variables
|
|
BUILDOS="linux" BUILDARCH="amd64" make build
|
|
|
|
#parameters
|
|
make run args="-h"
|
|
```
|
|
|
|
### Build
|
|
|
|
```bash
|
|
make build
|
|
```
|
|
|
|
the binary will be created on `bin/$BUILDOS_$BUILDARCH/git-sv`
|
|
|
|
### Tests
|
|
|
|
```bash
|
|
make test
|
|
```
|
|
|
|
### Run
|
|
|
|
```bash
|
|
#without args
|
|
make run
|
|
|
|
#with args
|
|
make run args="-h"
|
|
```
|