1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
git-feature(1) -- Create/Merge feature branch
========================================================
## SYNOPSIS
`git-feature` [-a|--alias <PREFIX>] [-s|--separator <SEPARATOR>] [-r|--remote [REMOTE_NAME]] [--from START_POINT] <NAME>...
`git-feature` [-a|--alias <PREFIX>] [-s|--separator <SEPARATOR>] finish [--squash] <NAME>...
## DESCRIPTION
Create or merge the given feature branch. The feature branch name is made from the <PREFIX>, the <SEPARATOR>, and the <NAME> joined together.
The default <PREFIX> is `feature` and <SEPARATOR> is `/`, which can be changed (see OPTIONS and GIT CONFIG for details).
The branch <NAME> may be specified as multiple words which will be joined with `-`. If the branch name contains the word `finish` or is another OPTION, `--` should be passed to stop OPTION parsing. See the EXAMPLES for details.
## OPTIONS
- `-a` <PREFIX>, `--alias` <PREFIX>:
The branch prefix to use, or `feature` if not supplied.
- `-s` <SEPARATOR>, `--separator` <SEPARATOR>:
The separator to use for joining the branch prefix and the branch name, or `/` if not supplied.
- `-r` [REMOTE_NAME], `--remote` [REMOTE_NAME]:
Setup a remote tracking branch using `remote_name`. If `remote_name` is not supplied, use `origin` by default.
- `--from` START_POINT:
Setup a start point when the branch created. If `--from` is not supplied, use the current branch by default. This option will be ignored when `finish`ing a branch.
- `finish`:
Merge and delete the feature branch.
- `--squash`:
Run a squash merge when `finish`ing the feature branch.
- <NAME>:
The name of the feature branch.
## GIT CONFIG
You can configure the default branch prefix and separator via git config options.
- `git-extras.feature.prefix`:
$ git config --global add git-extras.feature.prefix "prefix"
- `git-extras.feature.separator`:
$ git config --global add git-extras.feature.separator "-"
## EXAMPLES
- Start a new feature:
$ git feature dependencies
...
$ (feature/dependencies) git commit -m "Some changes"
- Finish a feature with --no-ff merge:
$ (feature/dependencies) git checkout master
$ git feature finish dependencies
- Finish a feature with --squash merge:
$ (feature/dependencies) git checkout master
$ git feature finish --squash dependencies
- Publish a feature upstream:
$ git feature dependencies -r upstream
- Use custom branch prefix:
$ git alias features "feature -a features"
$ git features dependencies
$ (features/dependencies) ...
$ (features/dependencies) git checkout master
$ git features finish dependencies
- Use custom branch separator:
$ git feature -s - dependencies
$ (feature-dependencies) ...
$ (feature-dependencies) git checkout master
$ git feature -s - finish dependencies
- Use custom branch prefix and separator from git config with multiple words:
$ git config --global --add git-extras.feature.prefix "features"
$ git config --global --add git-extras.feature.separator "."
$ git feature dependency tracking
$ (features.dependency-tracking) ...
$ (features.dependency-tracking) git checkout master
$ git feature finish dependency tracking
- Use a `git-feature` option or the `finish` command as part of a branch name:
$ git feature -- finish remote
...
$ (feature/finish-remote) git commit -m "Some changes"
$ (feature/finish-remote) git checkout main
$ git feature finish -- finish remote
## AUTHOR
Written by Jesús Espino <<jespinog@gmail.com>>
Modified by Mark Pitman <<mark.pitman@gmail.com>>
Modified by Carlos Prado <<carlos.prado@cpradog.com>>
Modified by Austin Ziegler <<halostatue@gmail.com>>
## REPORTING BUGS
<<https://github.com/tj/git-extras/issues>>
## SEE ALSO
<<https://github.com/tj/git-extras>>, git-create-branch(1), git-delete-branch(1)
|
