Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mritd/gitflow-toolkit
A simple toolkit for GitFlow.
https://github.com/mritd/gitflow-toolkit
gitflow gitflow-toolkit toolkit
Last synced: 3 days ago
JSON representation
A simple toolkit for GitFlow.
- Host: GitHub
- URL: https://github.com/mritd/gitflow-toolkit
- Owner: mritd
- License: mit
- Created: 2018-03-05T08:45:08.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T02:12:44.000Z (10 months ago)
- Last Synced: 2025-01-08T16:18:10.153Z (11 days ago)
- Topics: gitflow, gitflow-toolkit, toolkit
- Language: Go
- Homepage:
- Size: 8.18 MB
- Stars: 232
- Watchers: 5
- Forks: 18
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- charm-in-the-wild - gitflow-toolkit - A GitFlow submission tool. (_built with Bubble Tea_) (Applications / Development Tools)
README
# GitFlow ToolKit
> GitFlow Toolkit is a gitflow commit tool written by go, used to standardize the format of git commit message and quickly create gitflow branches,
> It should be noted that GitFlow Toolkit currently only supports the generation of the commit message style of the [Angular community specification](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.greljkmo14y0).
### Starting from the v2.1.1 version, the white theme terminal will be supported, and the white theme color scheme is being adjusted.
| | |
|:---------------------------------------------------------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------------------------------:|
| Install | Uninstall |
| 
| 
|
| Commit Success | Commit Failed |
| 
| 
|
| Push Success | Push Failed |
| 
| 
|
| Create Branch | |
| 
| |
## Installation
Just download the latest version from the Release page and execute the `install` command:
```sh
export VERSION='v2.1.5'
# download bin file
wget https://github.com/mritd/gitflow-toolkit/releases/download/${VERSION}/gitflow-toolkit-darwin-arm64
# add permissions
chmod +x gitflow-toolkit-darwin-arm64
# install
sudo ./gitflow-toolkit-darwin-arm64 install
```
After the installation is complete, you can delete the bin file.
If the go language development environment is installed locally, you can install it through the `go get` command:
```sh
go install github.com/mritd/gitflow-toolkit/v2@latest
```
## Comands
| cmd | desc |
|---------------------|-----------------------------------------------------------|
| `git ci` | Enter commit message interactively |
| `git ps` | Push the current branch to the remote |
| `git feat NAME` | Switch a new branch from the current branch (`feat/NAME`) |
| `git fix NAME` | `git switch -c fix/NAME` |
| `git hotfix NAME` | `git switch -c hotfix/NAME` |
| `git docs NAME` | `git switch -c docs/NAME` |
| `git style NAME` | `git switch -c style/NAME` |
| `git refactor NAME` | `git switch -c refactor/NAME` |
| `git chore NAME` | `git switch -c chore/NAME` |
| `git perf NAME` | `git switch -c perf/NAME` |
| `git style NAME` | `git switch -c style/NAME` |