| Vincent Driessen | 78c73dc | 2010-01-21 00:48:44 +0100 | [diff] [blame] | 1 | gitflow |
| 2 | ======= |
| 3 | A collection of Git wrapper scripts to provide high-level repository operations |
| 4 | for Vincent Driessen's [branching model](http://nvie.com/archives/323 "original |
| 5 | blog post"). |
| 6 | |
| 7 | Please help out |
| 8 | --------------- |
| 9 | This project is yet unimplemented. And yes, I mean unimplemented. There are no |
| 10 | scripts yet, but I will use this README file as the "design document" for now, |
| 11 | so people may start collaborating on it. |
| 12 | |
| 13 | Feel free to fork this repo and to commit your additions. |
| 14 | |
| 15 | Commands |
| 16 | -------- |
| 17 | Initially, the following subcommands to `gitflow` should be created: |
| 18 | |
| 19 | * `start` |
| 20 | * `finish` |
| 21 | |
| 22 | Those subcommands could work on branch types: |
| 23 | |
| 24 | * `feature` |
| 25 | * `release` |
| 26 | * `hotfix` |
| 27 | |
| 28 | Examples |
| 29 | -------- |
| 30 | |
| 31 | * To start a new feature branch, use: |
| 32 | |
| Vincent Driessen | e8766e0 | 2010-01-21 00:52:26 +0100 | [diff] [blame] | 33 | gitflow start feature <name> [<base>] |
| 34 | gitflow start feature foo-support |
| Vincent Driessen | 78c73dc | 2010-01-21 00:48:44 +0100 | [diff] [blame] | 35 | |
| 36 | `base` is `develop` by default. |
| 37 | |
| 38 | * To finish this feature and have it merged into `develop`, use: |
| 39 | |
| Vincent Driessen | 60e07ef | 2010-01-21 00:54:06 +0100 | [diff] [blame] | 40 | gitflow finish feature <name> |
| 41 | gitflow finish feature foo-support |
| Vincent Driessen | 78c73dc | 2010-01-21 00:48:44 +0100 | [diff] [blame] | 42 | |
| 43 | * To start a new release branch for 2.0, based on the 1.1 production release, use: |
| 44 | |
| Vincent Driessen | 60e07ef | 2010-01-21 00:54:06 +0100 | [diff] [blame] | 45 | gitflow start release <release> |
| 46 | gitflow start release 2.0 |
| Vincent Driessen | 78c73dc | 2010-01-21 00:48:44 +0100 | [diff] [blame] | 47 | |
| 48 | * To finish the release branch (i.e. to make an actual production release), use: |
| 49 | |
| Vincent Driessen | 60e07ef | 2010-01-21 00:54:06 +0100 | [diff] [blame] | 50 | gitflow finish release <release> |
| 51 | gitflow finish release 2.0 |
| Vincent Driessen | 78c73dc | 2010-01-21 00:48:44 +0100 | [diff] [blame] | 52 | |
| 53 | * To start a new hotfix branch for 2.1, based on the 2.0 production release, use: |
| 54 | |
| Vincent Driessen | 60e07ef | 2010-01-21 00:54:06 +0100 | [diff] [blame] | 55 | gitflow start hotfix <release> [<base-release>] |
| 56 | gitflow start hotfix 2.1 2.0 |
| Vincent Driessen | 78c73dc | 2010-01-21 00:48:44 +0100 | [diff] [blame] | 57 | |
| 58 | * To finish the hotfix branch, use: |
| 59 | |
| Vincent Driessen | 60e07ef | 2010-01-21 00:54:06 +0100 | [diff] [blame] | 60 | gitflow finish hotfix <release> |
| 61 | gitflow finish hotfix 2.1 |
| Vincent Driessen | 78c73dc | 2010-01-21 00:48:44 +0100 | [diff] [blame] | 62 | |