A command line tool (CLI) to validate commit messages, bump version, create tags and generate changelogs!
- Git 2.17+
- Download the latest release and add the binary to your path.
- Optional: Set
SV4GIT_HOMEto define user configs. Check the Config topic for more information.
If you want to install from source using go install, just run:
# keep in mind that with this, it will compile from source and won't show the version on cli -h.
go install github.com/bvieira/sv4git/v2/cmd/git-sv@latest
# if you want to add the version on the binary, run this command instead.
SV4GIT_VERSION=$(go list -f '{{ .Version }}' -m github.com/bvieira/sv4git/v2@latest | sed 's/v//') && go install --ldflags "-X main.Version=$SV4GIT_VERSION" github.com/bvieira/sv4git/v2/cmd/git-sv@v$SV4GIT_VERSIONThere are 3 config levels when using sv4git: default, user, repository. All of them are merged considering the follow priority: repository > user > default.
To see the current config, run:
git sv cfg showTo check the default configuration, run:
git sv cfg defaultFor user config, it is necessary to define the SV4GIT_HOME environment variable, eg.:
SV4GIT_HOME=/home/myuser/.sv4git # myuser is just an example.And create a config.yml file inside it, eg.:
.sv4git
└── config.ymlCreate a .sv4git.yml file on the root of your repository, eg.: .sv4git.yml.
version: "1.1" #config version
versioning: # versioning bump
update-major: [] # Commit types used to bump major.
update-minor: [feat] # Commit types used to bump minor.
update-patch: [build, ci, chore, fix, perf, refactor, test] # Commit types used to bump patch.
# When type is not present on update rules and is unknown (not mapped on commit message types);
# if ignore-unknown=false bump patch, if ignore-unknown=true do not bump version
ignore-unknown: false
tag:
pattern: '%d.%d.%d' # Pattern used to create git tag.
filter: '' # Enables you to filter for considerable tags using git pattern syntax
release-notes:
# Deprecated!!! please use 'sections' instead!
# Headers names for release notes markdown. To disable a section just remove the header
# line. It's possible to add other commit types, the release note will be created
# respecting the following order: feat, fix, refactor, perf, test, build, ci, chore, docs, style, breaking-change.
headers:
breaking-change: Breaking Changes
feat: Features
fix: Bug Fixes
sections: # Array with each section of release note. Check template section for more information.
- name: Features # Name used on section.
section-type: commits # Type of the section, supported types: commits, breaking-changes.
commit-types: [feat] # Commit types for commit section-type, one commit type cannot be in more than one section.
- name: Bug Fixes
section-type: commits
commit-types: [fix]
- name: Breaking Changes
section-type: breaking-changes
branches: # Git branches config.
prefix: ([a-z]+\/)? # Prefix used on branch name, it should be a regex group.
suffix: (-.*)? # Suffix used on branch name, it should be a regex group.
disable-issue: false # Set true if there is no need to recover issue id from branch name.
skip: [master, main, developer] # List of branch names ignored on commit message validation.
skip-detached: false # Set true if a detached branch should be ignored on commit message validation.
commit-message:
types: [build, ci, chore, docs, feat, fix, perf, refactor, revert, style, test] # Supported commit types.
header-selector: '' # You can put in a regex here to select only a certain part of the commit message. Please define a regex group 'header'.
scope:
# Define supported scopes, if blank, scope will not be validated, if not, only scope listed will be valid.
# Don't forget to add "" on your list if you need to define scopes and keep it optional.
values: []
footer:
issue: # Use "issue: {}" if you wish to disable issue footer.
key: jira # Name used to define an issue on footer metadata.
key-synonyms: [Jira, JIRA] # Supported variations for footer metadata.
use-hash: false # If false, use :<space> separator. If true, use <space># separator.
add-value-prefix: '' # Add a prefix to issue value.
issue:
regex: '[A-Z]+-[0-9]+' # Regex for issue id.sv4git uses go templates to format the output for release-notes and changelog, to see how the default template is configured check template directory. On v2.7.0+, its possible to overwrite the default configuration by adding .sv4git/templates on your repository. The cli expects that at least 2 files exists on your directory: changelog-md.tpl and releasenotes-md.tpl.
.sv4git
└── templates
├── changelog-md.tpl
└── releasenotes-md.tplEverything inside .sv4git/templates will be loaded, so it's possible to add more files to be used as needed.
To execute the template the releasenotes-md.tpl will receive a single ReleaseNote and changelog-md.tpl will receive a list of ReleaseNote as variables.
Each ReleaseNoteSection will be configured according with release-notes.section from config file. The order for each section will be maintained and the SectionType is defined according with section-type attribute as described on the table below.
| section-type | ReleaseNoteSection |
|---|---|
| commits | ReleaseNoteCommitsSection |
| breaking-changes | ReleaseNoteBreakingChangeSection |
⚠️ currently onlycommitsandbreaking-changesare supported assection-types, using a different value for this field will make the section to be removed from the template variables.
Check below the variables available:
ReleaseNote
Release string // 'v' followed by version if present, if not tag will be used instead.
Tag string // Current tag, if available.
Version *Version // Version from tag or next version according with semver.
Date time.Time
Sections []ReleaseNoteSection // ReleaseNoteCommitsSection or ReleaseNoteBreakingChangeSection
AuthorNames []string // Author names recovered from commit message (user.name from git)
Version
Major int
Minor int
Patch int
Prerelease string
Metadata string
Original string
ReleaseNoteCommitsSection // SectionType == commits
SectionType string
SectionName string
Types []string
Items []GitCommitLog
HasMultipleTypes bool
ReleaseNoteBreakingChangeSection // SectionType == breaking-changes
SectionType string
SectionName string
Messages []string
GitCommitLog
Date string
Timestamp int
AuthorName string
Hash string
Message CommitMessage
CommitMessage
Type string
Scope string
Description string
Body string
IsBreakingChange bool
Metadata map[string]stringBeside the go template functions, the folowing functions are availiable to use in the templates. Check formatter_functions.go to see the functions implementation.
Usage: timefmt time "2006-01-02"
Receive a time.Time and a layout string and returns a textual representation of the time according with the layout provided. Check https://pkg.go.dev/time#Time.Format for more information.
Usage: getsection sections "Features"
Receive a list of ReleaseNoteSection and a Section name and returns a section with the provided name. If no section is found, it will return nil.
Run git-sv to get the list of available parameters:
git-svIf git-sv is configured on your path, you can use it like a git command:
git sv
git sv current-version
git sv next-versionUse --help or -h to get usage information, don't forget that some commands have unique options too:
# sv help
git-sv -h
# sv release-notes command help
git-sv rn -h| Variable | description | has options or subcommands |
|---|---|---|
| config, cfg | Show config information. | ✔️ |
| 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 according to range as jsons. | ✔️ |
| commit-notes, cn | Generate a commit notes according to range. | ✔️ |
| release-notes, rn | Generate release notes. | ✔️ |
| changelog, cgl | Generate changelog. | ✔️ |
| tag, tg | Generate tag with version based on git commit messages. | ❌ |
| commit, cmt | Execute git commit with convetional commit message helper. | ✔️ |
| validate-commit-message, vcm | Use as prepare-commit-message hook to validate commit message. | ✔️ |
| help, h | Shows a list of commands or help for one command. | ❌ |
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 at git log, all dates returned from it will be in YYYY-MM-DD format.
Range tag will use git for-each-ref refs/tags 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. 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. If end is empty, HEAD will be used instead.
# 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 tagConfigure your .git/hooks/prepare-commit-msg:
#!/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:
git config --global init.templatedir '<YOUR TEMPLATE DIR>'Check git config docs for more information!
Run make to get the list of available actions:
make| 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"make buildThe binary will be created on bin/$BUILDOS_$BUILDARCH/git-sv.
make test#without args
make run
#with args
make run args="-h"
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent