https://github.com/crazyfactory/gitflow

cli for gitflow
https://github.com/crazyfactory/gitflow

Last synced: about 1 month ago
JSON representation

cli for gitflow

• Host: GitHub
• URL: https://github.com/crazyfactory/gitflow
• Owner: crazyfactory
• Created: 2019-03-28T06:00:18.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T19:00:33.000Z (about 2 years ago)
• Last Synced: 2024-11-06T08:18:08.641Z (3 months ago)
• Language: JavaScript
• Size: 1.27 MB
• Stars: 2
• Watchers: 9
• Forks: 0
• Open Issues: 25
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Gitflow

## Install

```sh

$ npm install -g @crazyfactory/gitflow

```

## Usages

### `$ gitflow alias  `

Set `` as an alias of `` which you can run as `gitflow `

### `$ gitflow set-config`

Set `project_name` and `sprint_number` for current path

  

### `$ gitflow get-config`

Get `project_name` and `sprint_number` for current path

  

### `$ gitflow generate-token`

Fill in your Github username and password to let Gitflow create personal access token

### `$ gitflow remove-token`

Delete personal access token locally

### `$ gitflow start-sprint [project] [sprintNum]`

  - Create new local sprint branch

  - Branch out from `origin/develop`

  - Naming convention: `{project_name}/sprint-{sprint_number}`

  - Push to origin

### `$ gitflow finish-sprint` 

  - Switch to `origin/{project_name}/sprint-{sprint_number}`

  - Create pull and fill content `Closes #{issue_number}` to `origin/develop` 

  - Switch local to `origin/develop`

### `$ gitflow start-feature [feature-branch]`

  - Create new local feature branch

  - If project is maintenance, branch out from `develop`, otherwise branch out from `origin/{project_name}/sprint-{number}`

  - Naming convention: `{project_name}-sprint-{number}/{issue_number}-{feature_name}`

  - Push to origin

### `$ gitflow finish-feature`

  - Push local branch to origin

  - If project name is maintenance create pull to `develop`, otherwise create pull to `origin/{project_name}/sprint-{sprint_number}`. Then fill content `Closes #{issue_number}`. 

  - Switch local to `origin/{project_name}/sprint-{sprint_number}`

### `$ gitflow start-hotfix [hotfix-branch]`

  - Create a new local hotfix branch

  - Branch out from `origin/master`

  - Naming convention: `{issue_number}-{hotfix_name}`

  - Push to origin

### `$ gitflow finish-hotfix`

  - Push local branch to origin

  - Create pull and fill content `Closes #{issue_number}` to `origin/master`

  - Switch local branch to `origin/master`

### `$ gitflow soft-push`

  - Create an empty commit and push it