git-flow.rs

Extensible git flow written in rust.

Installation

cargo install git-flow-rs
# or download the released executable file.

Usage

git-flow --help

Extensible git flow written in rust.

Usage: git-flow <command>

Avaliable commands:

-h, --help
        Print help
-v, --version
        Print version
start [<branch_type> <branch_name>]/[<full_branch_name>]
        start a task
finish [<branch_type> <branch_name>]/[<full_branch_name>]
        finish a task
drop [<branch_type> <branch_name>]/[<full_branch_name>]
        give up a task
track [<branch_type> <branch_name>]/[<full_branch_name>]
        track a task

Configured branch types:

feature
        from dev to dev
...

A small usage flow example using the configuration below.

# start a feature
git-flow start feature something
# or git-flow start feature/something
# then branch feature/something created from dev

# implement the feature
# commit changes

# finish the feature
git-flow finish feature/something
# then feature/something merged into dev and this branch deleted

Config

Global config file should located at ~/.config/git-flow/.git-flow.json(or C:\Users\YourUsername\AppData\Roaming\git-flow\.git-flow.json on windows).

Local config file should located at <GitRoot>/.git-flow.json.

There is no default configuration builtin. Here is an example.

Avaliable strategy: merge, rebase, cherry-pick.

[
  {
    "type": "feature",
    "name": "feature/{new_branch}",
    "from": "dev",
    "to": [
      {
        "branch": "dev",
        "strategy": "merge"
      }
    ]
  },
  {
    "type": "hotfix",
    "name": "hotfix/{new_branch}",
    "from": "main",
    "to": [
      {
        "branch": "main",
        "strategy": "merge"
      },
      {
        "branch": "dev",
        "strategy": "merge"
      }
    ]
  },
  {
    "type": "bugfix",
    "name": "bugfix/{new_branch}",
    "from": "dev",
    "to": [
      {
        "branch": "dev",
        "strategy": "merge"
      }
    ]
  },
  {
    "type": "release",
    "name": "release/{new_branch}",
    "from": "dev",
    "to": [
      {
        "branch": "main",
        "strategy": "merge"
      }
    ]
  }
]