Package Exports

hgit
hgit/bin/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hgit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

hgit-cli

🚀 an unopinionated git workflow cli tool

Streamline and Simplify complex git processes

hgit v0.32.5-0

Sample Config

sample-generated-config-file

sample

{
  "config_version": "0.33.3",
  "trunk_branch_name": "flight",
  "sleep_between_commands": 2000,
  "graph_git_log_limit": 40,
  "bug_tracker_path": "https://metaory.atlassian.net/browse/{taskId}",
  "commands": {
    "git_push_origin": "git push --set-upstream origin {branchName}",
    "git_checkout_branch": "git checkout {branchName}",
    "git_create_branch": "git checkout -b {branchName}",
    "git_fetch_origin": "git fetch origin || true",
    "git_checkout_dev": "git checkout dev",
    "git_merge_dev": "git merge origin/dev",
    "git_checkout_master": "git checkout master",
    "git_merge_master": "git merge origin/master",
    "git_is_inside_worktree": "git rev-parse --is-inside-work-tree",
    "git_prune": "git gc --prune=now && git remote prune origin",
    "git_reset_master": "git reset --hard master",
    "git_reset_head": "git reset --hard HEAD~1",
    "git_merge_abort": "git merge --abort || true",
    "git_is_dirty": "git status --short",
    "git_status": "git status"
  },
  "checkout": [
    "git_fetch_origin",
    "git_checkout_branch",
    "git_status"
  ],
  "start_workflow": {
    "flight__branch_pattern": "flight/{description}",
    "flight": [
      "git_fetch_origin",
      "git_checkout_master",
      "git_merge_master",
      "git_create_branch",
      "git_status"
    ],
    "feature__branch_pattern": "{branchType}/{taskId}-{description}",
    "feature": [
      "git_fetch_origin",
      "git_checkout_master",
      "git_merge_master",
      "prompt_checkout_flight",
      "git_create_branch",
      "git_status"
    ],
    "bugfix__branch_pattern": "{branchType}/{taskId}-{description}",
    "bugfix": [
      "git_fetch_origin",
      "git_checkout_master",
      "git_merge_master",
      "prompt_checkout_flight",
      "git_create_branch",
      "git_status"
    ],
    "other__branch_pattern": "{branchType}/{taskId}-{description}",
    "other": [
      "git_fetch_origin",
      "git_checkout_master",
      "git_merge_master",
      "prompt_checkout_flight",
      "git_create_branch",
      "git_status"
    ],
    "hotfix__branch_pattern": "{branchType}/{taskId}-{description}",
    "hotfix": [
      "git_fetch_origin",
      "git_checkout_master",
      "git_merge_master",
      "git_create_branch",
      "git_status"
    ]
  }
}

Features

check for conflict between multiple remote branch
start new workflows from a config file
ALL commands are read from the config file in ~/.config/hgit/config.json
dynamic branch checkout in workflows with command: prompt_checkout_{pattern}
branchNamePattern from config: {branchType}__branch_pattern

npx

npx hgit

Installation

npm i -g hgit

Usage

hgit

Options

--verbose               | verbose logs

TL;DR

The Default configs

branch	create from	can sync from	branch name
flight	master	master	`flight/{description}`
hotfix	master	master	`hotfix/{taskId}-{description}`
feature	flight	parent flight	`feature/{taskId}-{description}`
bugfix	flight	parent flight	`bugfix/{taskId}-{description}`
other	flight	parent flight	`other/{taskId}-{description}`

Hotfix branch:

Can only be created from master
While branch in active, can sync from master
Cannot take pull from dev
Should not take pull from another feature / flight / hotfix branch

Flight branch:

Will only be created from master
Can sync from master
Cannot sync from dev

feature/bugfix/other in Flight (Child branch -> Flight branch):

Task branches (feature/bugfix/other) should be created from the Flight branch
Cannot take pull from any branch but Flight branch
Can take pull from a sibling branch of the same flight if it depends on it

Flights(trunk)

flight is for the features, bugs, and improvements corresponding to the flight (epic) in the BugTracking system
Ticket branches can be created from a flight branch.
There are 3 ticket branch prefixes: feature, bugfix, and other. These branches require a BugTracking task ID in their names.

feature is for the small packed features inside the flight.
bugfix is for the fixes and issues related to the flight.
other is used for non-technical issues like documentation or infrastructure improvements, etc.

Hotfix

hotfix is dedicated to fixes regarding critical issues in the production environment.