Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kazhuravlev/git-tools
Useful set of tools which helps to manage git tags
https://github.com/kazhuravlev/git-tools
automation git git-tags go golang tool
Last synced: 1 day ago
JSON representation
Useful set of tools which helps to manage git tags
- Host: GitHub
- URL: https://github.com/kazhuravlev/git-tools
- Owner: kazhuravlev
- License: mit
- Created: 2022-05-05T22:56:20.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T16:27:01.000Z (3 months ago)
- Last Synced: 2024-08-14T18:07:23.189Z (3 months ago)
- Topics: automation, git, git-tags, go, golang, tool
- Language: Go
- Homepage:
- Size: 86.9 KB
- Stars: 32
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Git Tools
[](https://pkg.go.dev/github.com/kazhuravlev/git-tools)
[](https://github.com/kazhuravlev/git-tools/blob/master/LICENSE)
[](https://github.com/kazhuravlev/git-tools/actions/workflows/release.yml)
[](https://goreportcard.com/report/github.com/kazhuravlev/git-tools)
Set of helpful tools to do a routine job.
This tool can help you to work with a bunch of lib/services under your projects.
Especially when you start a new project - you need to increment a version of the
SDK repo too often. `gt` allows you to work
like `git commit -a -m 'some changes' && gt t i min && gt p a`. This set of
commands reads as "commit changes, increment minor version of last semver tag,
push commits to the origin with tags". Pretty simple, huh?
`gt` try to follow a chosen format of semver tags which you choose (`v1.2.3`
/`1.2.3`). If you want to follow a selected pattern, just add `gt` to your CI
system or `git-hook` and check that all tags have one concrete format.
See [Usage](#Usage).
## Installation
**Golang**
```shell
go install github.com/kazhuravlev/git-tools/cmd/gt@latest
```
**Homebrew**
```shell
brew install kazhuravlev/git-tools/git-tools
```
**Docker (zsh)** (will work only in current directory)
```shell
echo 'alias gt="docker run -it --rm -v `pwd`:/workdir kazhuravlev/gt:latest"' >> ~/.zshrc
```
## Usage
By default, `gt` works with the repo in the current directory. If you want to
specify another path to repo - add `--repo=/path/to/repo` flag.
```shell
gt --repo /path/to/repo tag last
```
| Command | Action |
|---------------------|--------------------------------------------------------------|
| `t l` | Show last semver tag in this repo |
| `t i major` | Increment `major` part for semver |
| `t i minor` | Increment `minor` part for semver |
| `t i patch` | Increment `patch` part for semver |
| `lint` | Run linter, that check the problems |
| `hooks install all` | Install commit-msg hook that adds branch name to each commit |
### Force add new semver tag
By default `gt` will throw an error when you try to increment a tag on commit, that already have another semver tag.
In order to skip this error - provide additional flag to increment command like
that: `gt t i min --ignore-exists-tag`.
### Examples
```shell
# Get last semver tag in this repo
$ gt tag last
v1.9.0 (c2e70ec90579ba18fd73078e98f677aec75ae002)
# Show only tag name (useful for ci/cd)
$ gt tag last -f tag
v1.9.0
```