gobranch

command module
v0.0.0-...-debcc72 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 19, 2021 License: MIT Imports: 3 Imported by: 0

README

GoBranch

Go Report Card Release Status Go GitHub license

A command line app to help you quickly creating git branch without hassle steps.

THIS CLI APP IS NOT WORKING NEED TO BE UPDATED

Usage

$ GoBranch

gobranch

Features

  • You don't need to type a valid branch name
  • You don't need to checkout to the base branch
  • You don't need to git pull the base branch
  • Automatic prefixes such as feature, enhance, bugfix, hotfix, release
  • Prevent the selected base branch from being wrong
  • Custom base branch
  • Custom naming conventions

Requirements

  • Git

Installation with Go

$ go get github.com/ipanardian/GoBranch

Update GoBranch

$ go get -u github.com/ipanardian/GoBranch

Installation executable file only

  • Open the release section
  • Download binary files that match with your operating system (OS)
  • Change the name to "GoBranch" or "GoBranch.exe" for windows
  • add it to your $PATH environment variable, so you can run it from any location on the command line
  • On mac copy to /usr/local/bin
  • Then sudo chmod +x /usr/local/bin/GoBranch

Naming Conventions

$ GoBranch --tc "/" --nc "snake"
//output: feature/abcd_efgh 

$ GoBranch --tc "-" --nc "kebab"
//output: feature-abcd-efgh

//Default: feature/abcd_efgh 

Branch Tree

The following is a branch of the GoBranch tree, you must have a branch development and hotfix, unless you choose custom then there is no need to follow this diagram.

 -- master
 -- staging
    |-- development
    |   |-- feature/{name}
    |   |-- enhance/{name}
    |   |-- bugfix/{name}
    |   `-- test/{name}
    `-- hotfix
        `-- hot/{name}
-- production

Flags

//Show help
$ GoBranch --help or -h

//Show version
$ GoBranch --version or -v

//Set type convention
$ GoBranch --tc /
//output: feature/{branch}

//Set naming convention
$ GoBranch --nc kebab
//output: branch-name

License

The MIT License (MIT)

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL