forked from nvie/gitflow
-
Notifications
You must be signed in to change notification settings - Fork 0
/
git-flow-feature
1146 lines (985 loc) · 35.7 KB
/
git-flow-feature
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# git-flow -- A collection of Git extensions to provide high-level
# repository operations for Vincent Driessen's branching model.
#
# Original blog post presenting this model is found at:
# http://nvie.com/git-model
#
# Feel free to contribute to this project at:
# http://github.com/nvie/gitflow
#
# Copyright 2010 Vincent Driessen. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY VINCENT DRIESSEN ``AS IS'' AND ANY EXPRESS OR
# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
# EVENT SHALL VINCENT DRIESSEN OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
# EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and documentation are
# those of the authors and should not be interpreted as representing official
# policies, either expressed or implied, of Vincent Driessen.
#
init
init() {
require_git_repo
require_gitflow_initialized
gitflow_load_settings
PREFIX=$(git config --get gitflow.prefix.feature)
PROJECT_PREFIX=project
DEVELOP_NAME=$(git config --get gitflow.branch.develop)
DEVELOP_NAME=${DEVELOP_NAME:-develop}
NS=$(git_current_namespace)
DEVELOP_BRANCH=${NS}${DEVELOP_NAME}
PREFIX=${NS}${PREFIX}
PROJECT=$(git_current_branch | sed -n "s,^${PREFIX}\\([^/]*\\)/.*,\\1,p")
[ "$PROJECT" ] || PROJECT=$(git_current_branch | sed -n "s,^${NS}${PROJECT_PREFIX}/\\([^/]*\\)\$,\\1,p")
[ "$PROJECT" ] && PREFIX=${PREFIX}${PROJECT}/
[ "$PROJECT" ] && DEVELOP_BRANCH=${NS}${PROJECT_PREFIX}/${PROJECT}
}
cmd_test() {
echo "NS = $NS"
echo "PROJECT = $PROJECT"
echo "PREFIX = $PREFIX"
echo "DEVELOP = $DEVELOP_BRANCH"
}
usage() {
echo "usage: git flow feature [list] [-v]"
echo " git flow feature start [-F] <name> [<base>]"
echo " git flow feature finish [-rFkDS] [<name|nameprefix>]"
echo " git flow feature delete [<name|nameprefix>]"
echo " git flow feature publish <name>"
echo " git flow feature track <name>"
echo " git flow feature diff [<name|nameprefix>]"
echo " git flow feature rebase [-i] [<name|nameprefix>]"
echo " git flow feature checkout [<name|nameprefix>]"
echo " git flow feature pull [-r] <remote> [<name>]"
}
init_restore_branch() {
trap "git checkout -q $(git_symbolic_head)" INT TERM EXIT
}
cancel_restore_branch() {
trap - INT TERM EXIT
}
cmd_default() {
cmd_list "$@"
}
cmd_list() {
DEFINE_boolean verbose false 'verbose (more) output' v
parse_args "$@"
local feature_branches
local current_branch
local short_names
feature_branches=$(echo "$(git_local_branches)" | grep "^$PREFIX")
if [ -z "$feature_branches" ]; then
warn "No feature branches exist."
warn ""
warn "You can start a new feature branch:"
warn ""
warn " git flow feature start <name> [<base>]"
warn ""
exit 0
fi
current_branch=$(git branch --no-color | grep '^\* ' | grep -v 'no branch' | sed 's/^* //g')
short_names=$(echo "$feature_branches" | sed "s ^$PREFIX g")
# determine column width first
local width=0
local branch
for branch in $short_names; do
local len=${#branch}
width=$(max $width $len)
done
width=$(($width+3))
local branch
for branch in $short_names; do
local fullname=$PREFIX$branch
local base=$(git merge-base "$fullname" "$DEVELOP_BRANCH")
local develop_sha=$(git rev-parse "$DEVELOP_BRANCH")
local branch_sha=$(git rev-parse "$fullname")
if [ "$fullname" = "$current_branch" ]; then
printf "* "
else
printf " "
fi
if flag verbose; then
printf "%-${width}s" "$branch"
if [ "$branch_sha" = "$develop_sha" ]; then
printf "(no commits yet)"
elif [ "$base" = "$branch_sha" ]; then
printf "(is behind develop, may ff)"
elif [ "$base" = "$develop_sha" ]; then
printf "(based on latest develop)"
else
printf "(may be rebased)"
fi
else
printf "%s" "$branch"
fi
echo
done
}
cmd_help() {
usage
exit 0
}
require_name_arg() {
if [ "$NAME" = "" ]; then
warn "Missing argument <name>"
usage
exit 1
fi
}
expand_nameprefix_arg() {
require_name_arg
local expanded_name
local exitcode
expanded_name=$(gitflow_resolve_nameprefix "$NAME" "$PREFIX")
exitcode=$?
case $exitcode in
0) NAME=$expanded_name
BRANCH=$PREFIX$NAME
;;
*) exit 1 ;;
esac
REMOTE_BRANCH=$(get_tracked_branch)
}
use_current_feature_branch_name() {
local current_branch=$(git_current_branch)
if startswith "$current_branch" "$PREFIX"; then
BRANCH=$current_branch
NAME=${BRANCH#$PREFIX}
else
warn "The current HEAD is no feature branch."
warn "Please specify a <name> argument."
exit 1
fi
REMOTE_BRANCH=$(get_tracked_branch)
}
expand_nameprefix_arg_or_current() {
if [ "$NAME" != "" ]; then
expand_nameprefix_arg
require_branch "$PREFIX$NAME"
else
use_current_feature_branch_name
fi
}
name_or_current() {
if [ -z "$NAME" ]; then
use_current_feature_branch_name
fi
}
get_tracked_branch() {
[ "$(git config "branch.$BRANCH.remote")" == "$ORIGIN" ] || return 1
local remote_branch=$(git config "branch.$BRANCH.merge" | sed -n 's,^refs/heads/,,p')
[ "$remote_branch" ] || return 1
has "$ORIGIN/$remote_branch" $(git_remote_branches) || return 1
echo "$remote_branch"
}
has_tracked_branch() {
get_tracked_branch >/dev/null
}
parse_args() {
# parse options
FLAGS "$@" || exit $?
eval set -- "${FLAGS_ARGV}"
# read arguments into global variables
NAME=$1
BRANCH=$PREFIX$NAME
REMOTE_BRANCH=$(get_tracked_branch)
}
parse_remote_name() {
# parse options
FLAGS "$@" || exit $?
eval set -- "${FLAGS_ARGV}"
# read arguments into global variables
REMOTE=$1
NAME=$2
BRANCH=$PREFIX$NAME
}
gerrit_host() {
local val
val=$(git config --get "remote.$ORIGIN.url" | sed 's,^ssh://\([^:]*\):\([^/]*\)/.*$,\1,')
[[ -z "$val" ]] && fail "Couldn't get gerrit host from config: remote.$ORIGIN.url"
echo $val
}
gerrit_port() {
local val
val=$(git config --get "remote.$ORIGIN.url" | sed 's,^ssh://\([^:]*\):\([^/]*\)/.*$,\2,')
[[ -z "$val" ]] && fail "Couldn't get gerrit port from config: remote.$ORIGIN.url"
echo $val
}
gerrit_query() {
ssh -p $(gerrit_port) $(gerrit_host) "gerrit query $1"
}
gerrit_query_filter() {
local res=$(cat)
rows=$(echo "$res" | awk '/^rowCount:/ {print $2}')
[ "$rows" == "1" ] || return 1
local filter=$1
value=$(echo "$res" | sed -n "s/^\\s*$filter: //p")
[ "$value" ] || return 1
echo "$value"
}
gerrit_push() {
local err
err=$(git push "$ORIGIN" "$1" 2>&1) || {
echo "Gerrit Error: " >&2
echo "$err" | egrep '(error|!)' >&2
return 1
}
}
cmd_start() {
DEFINE_boolean fetch false 'fetch from origin before performing local operation' F
parse_args "$@"
BASE=${2:-$DEVELOP_BRANCH}
[ "$BASE" ] || fail "Could not determine which 'develop' to branch from. Specify a base explicitly."
require_name_arg
# If current branch is product branch, gitflow should give a warning and quit
current_branch_name=$(git_current_branch)
if [ "$(echo "$current_branch_name" | grep "/product")" ]; then
die "please don't use git flow on product branch"
fi
# sanity checks
require_branch_absent "$BRANCH"
# update the local repo with remote changes, if asked
if flag fetch; then
git_do fetch -q "$ORIGIN" "$DEVELOP_BRANCH"
fi
# if the origin branch counterpart exists, assert that the local branch
# isn't behind it (to avoid unnecessary rebasing)
if git_branch_exists "$ORIGIN/$DEVELOP_BRANCH"; then
require_branches_equal "$DEVELOP_BRANCH" "$ORIGIN/$DEVELOP_BRANCH"
fi
# create branch
echo git checkout -b "$BRANCH" "$BASE"
if ! git checkout -b "$BRANCH" "$BASE"; then
die "Could not create feature branch '$BRANCH'"
fi
echo
echo "Summary of actions:"
echo "- A new branch '$BRANCH' was created, based on '$BASE'"
echo "- You are now on branch '$BRANCH'"
echo ""
echo "Now, start committing on your feature. When done, use:"
echo ""
echo " git flow feature submit $NAME"
echo ""
echo "If you want to colaborate on the feature, use:"
echo ""
echo " git flow feature publish $NAME"
echo ""
echo "If you want to abandon the feature, or if it has been merged into develop, use:"
echo ""
echo " git flow feature delete $NAME"
echo
}
cmd_finish() {
DEFINE_boolean fetch false "fetch from $ORIGIN before performing finish" F
DEFINE_boolean rebase false "rebase instead of merge" r
DEFINE_boolean keep false "keep branch after performing finish" k
DEFINE_boolean force_delete false "force delete feature branch after finish" D
DEFINE_boolean squash false "squash feature during merge" S
parse_args "$@"
expand_nameprefix_arg_or_current
# sanity checks
require_branch "$BRANCH"
# detect if we're restoring from a merge conflict
if [ -f "$DOT_GIT_DIR/.gitflow/MERGE_BASE" ]; then
#
# TODO: detect that we're working on the correct branch here!
# The user need not necessarily have given the same $NAME twice here
# (although he/she should).
#
# TODO: git_is_clean_working_tree() should provide an alternative
# exit code for "unmerged changes in working tree", which we should
# actually be testing for here
if git_is_clean_working_tree; then
FINISH_BASE=$(cat "$DOT_GIT_DIR/.gitflow/MERGE_BASE")
# Since the working tree is now clean, either the user did a
# succesfull merge manually, or the merge was cancelled.
# We detect this using git_is_branch_merged_into()
if git_is_branch_merged_into "$BRANCH" "$FINISH_BASE"; then
rm -f "$DOT_GIT_DIR/.gitflow/MERGE_BASE"
helper_finish_cleanup
exit 0
else
# If the user cancelled the merge and decided to wait until later,
# that's fine. But we have to acknowledge this by removing the
# MERGE_BASE file and continuing normal execution of the finish
rm -f "$DOT_GIT_DIR/.gitflow/MERGE_BASE"
fi
else
echo
echo "Merge conflicts not resolved yet, use:"
echo " git mergetool"
echo " git commit"
echo
echo "You can then complete the finish by running it again:"
echo " git flow feature finish $NAME"
echo
exit 1
fi
fi
# sanity checks
require_clean_working_tree
# update local repo with remote changes first, if asked
if has "$ORIGIN/$BRANCH" $(git_remote_branches); then
if flag fetch; then
git_do fetch -q "$ORIGIN" "$BRANCH"
git_do fetch -q "$ORIGIN" "$DEVELOP_BRANCH"
fi
fi
if has "$ORIGIN/$BRANCH" $(git_remote_branches); then
require_branches_equal "$BRANCH" "$ORIGIN/$BRANCH"
fi
if has "$ORIGIN/$DEVELOP_BRANCH" $(git_remote_branches); then
require_branches_equal "$DEVELOP_BRANCH" "$ORIGIN/$DEVELOP_BRANCH"
fi
# if the user wants to rebase, do that first
if flag rebase; then
if ! git flow feature rebase "$NAME" "$DEVELOP_BRANCH"; then
warn "Finish was aborted due to conflicts during rebase."
warn "Please finish the rebase manually now."
warn "When finished, re-run:"
warn " git flow feature finish '$NAME' '$DEVELOP_BRANCH'"
exit 1
fi
fi
# merge into BASE
git_do checkout "$DEVELOP_BRANCH"
if [ "$(git rev-list -n2 "$DEVELOP_BRANCH..$BRANCH" | wc -l)" -eq 1 ]; then
git_do merge --ff "$BRANCH"
else
if noflag squash; then
git_do merge --no-ff "$BRANCH"
else
git_do merge --squash "$BRANCH"
git_do commit
git_do merge "$BRANCH"
fi
fi
if [ $? -ne 0 ]; then
# oops.. we have a merge conflict!
# write the given $DEVELOP_BRANCH to a temporary file (we need it later)
mkdir -p "$DOT_GIT_DIR/.gitflow"
echo "$DEVELOP_BRANCH" > "$DOT_GIT_DIR/.gitflow/MERGE_BASE"
echo
echo "There were merge conflicts. To resolve the merge conflict manually, use:"
echo " git mergetool"
echo " git commit"
echo
echo "You can then complete the finish by running it again:"
echo " git flow feature finish $NAME"
echo
exit 1
fi
# when no merge conflict is detected, just clean up the feature branch
helper_finish_cleanup
}
helper_finish_cleanup() {
# sanity checks
require_branch "$BRANCH"
require_clean_working_tree
# delete branch
if flag fetch; then
git_do push "$ORIGIN" ":refs/heads/$BRANCH"
fi
if noflag keep; then
if flag force_delete; then
git_do branch -D "$BRANCH"
else
git_do branch -d "$BRANCH"
fi
fi
echo
echo "Summary of actions:"
echo "- The feature branch '$BRANCH' was merged into '$DEVELOP_BRANCH'"
#echo "- Merge conflicts were resolved" # TODO: Add this line when it's supported
if flag keep; then
echo "- Feature branch '$BRANCH' is still available"
else
echo "- Feature branch '$BRANCH' has been removed"
fi
echo "- You are now on branch '$DEVELOP_BRANCH'"
echo
}
cmd_fromreview() {
info=$(gerrit_query "commit:$(git rev-parse HEAD)") \
|| fail "Couldn't contact Gerrit"
if [ "$(echo "$info" | gerrit_query_filter rowCount)" != "1" ]; then
warn ""
warn "Couldn't find the Gerrit review for commit $(git rev-parse HEAD)."
warn "Usage: First check out a patchset from Gerrit, then run 'git flow feature fromreview <name>'."
fail "Couln't find change."
fi
[ "$(echo "$info" | gerrit_query_filter open)" == "true" ] \
|| fail "The Gerrit review is closed."
DEVELOP_BRANCH=$(echo "$info" | gerrit_query_filter branch) \
|| fail "Couldn't query Gerrit to get information about the change."
[ $(echo "$DEVELOP_BRANCH" | sed -n "s,^\([^/]*/\)\?\($DEVELOP_NAME\|$PROJECT_PREFIX/\([^/]\+\)\)$,\2,p") ] || \
fail "Couldn't detect valid develop branch from Gerrit change: '$DEVELOP_BRANCH'"
NS=$(echo "$DEVELOP_BRANCH" | sed -n "s,^\([^/]*/\)\?\($DEVELOP_NAME\|$PROJECT_PREFIX/\([^/]\+\)\)$,\1,p")
PROJECT=$(echo "$DEVELOP_BRANCH" | sed -n "s,^\([^/]*/\)\?\($DEVELOP_NAME\|$PROJECT_PREFIX/\([^/]\+\)\)$,\3,p")
PREFIX=$(git config --get gitflow.prefix.feature)
PREFIX=${NS}${PREFIX}
[ "$PROJECT" ] && PREFIX=${PREFIX}${PROJECT}/
parse_args "$@"
require_name_arg
# sanity checks
require_branch_absent "$BRANCH"
# Sanity check that this commit is based on the develop branch
[ "$(git_get_first_feature_branch_commit HEAD)" == "$(git rev-parse HEAD)" ] \
|| fail "Gerrit commit not direct descendent of $DEVELOP_BRANCH. Try pull'ing the latest develop."
old_change_id=$(git_change_id HEAD) || fail "Couldn't determine Change-Id"
new_change_id=$(git_derived_change_id review HEAD) || fail "Couldn't determine Change-Id"
new_commit_msg=$(commit_message HEAD | replace_change_id "$new_change_id")
# create branch
if ! git checkout -b "$BRANCH"; then
die "Could not create feature branch '$BRANCH'"
fi
echo "$new_commit_msg" | git commit -q --amend --file=- || fail "Couldn't update commit message"
echo
echo "Summary of actions:"
echo "- A new branch '$BRANCH' was created, based on change $old_change_id"
echo "- You are now on branch '$BRANCH'"
echo ""
echo "Now, start committing on your feature. When done, use:"
echo ""
echo " git flow feature submit $NAME"
echo ""
echo "If you want to abandon the feature, or if it has been merged into develop, use:"
echo ""
echo " git flow feature delete $NAME"
echo
}
cmd_publish() {
parse_args "$@"
expand_nameprefix_arg_or_current
# sanity checks
require_clean_working_tree
require_branch "$BRANCH"
local err=$(git fetch -q "$ORIGIN" "refs/heads/$BRANCH:refs/remotes/$ORIGIN/$BRANCH" 2>&1 | grep "Couldn't find remote ref")
if [ "$err" ]; then
rm $DOT_GIT_DIR/refs/remotes/$ORIGIN/$BRANCH 2>/dev/null
fi
if has "$ORIGIN/$BRANCH" $(git_all_branches); then
err=$(git push $ORIGIN "$BRANCH:refs/heads/$BRANCH" 2>&1)
echo "$err"
if [ "$(echo "$err" | grep "non-fast-forward updates were rejected")" ]; then
warn ""
warn "*** ERROR: Couldn't push your branch."
warn ""
if [ "$(git config --get "branch.$BRANCH.remote")" ]; then
warn " The remote feature branch could not be fast-forwarded."
warn ""
warn " Use 'git pull --rebase' to get the latest changes from the server."
else
warn " A feature branch named '$BRANCH' already exists on the server."
warn ""
warn " To select a different name for your branch, use:"
warn " git branch -m ${BRANCH} ${PREFIX}<newname>"
fi
die ""
fi
exit 0
fi
# create remote branch
git push "$ORIGIN" "$BRANCH:refs/heads/$BRANCH"
git fetch -q "$ORIGIN" "refs/heads/$BRANCH:refs/remotes/$ORIGIN/$BRANCH"
# configure remote tracking
git config "branch.$BRANCH.remote" "$ORIGIN"
git config "branch.$BRANCH.merge" "refs/heads/$BRANCH"
git config "branch.$BRANCH.rebase" true
git checkout "$BRANCH"
echo
echo "Summary of actions:"
echo "- A new remote branch '$BRANCH' was created"
echo "- The local branch '$BRANCH' was configured to track the remote branch"
echo "- You are now on branch '$BRANCH'"
echo
}
cmd_track() {
parse_args "$@"
require_name_arg
# sanity checks
require_clean_working_tree
require_branch_absent "$BRANCH"
git fetch -q "$ORIGIN" "refs/heads/$BRANCH:refs/remotes/$ORIGIN/$BRANCH"
require_branch "$ORIGIN/$BRANCH"
# create tracking branch
git checkout -b "$BRANCH" "$ORIGIN/$BRANCH"
git config "branch.$BRANCH.remote" "$ORIGIN"
git config "branch.$BRANCH.merge" "refs/heads/$BRANCH"
git config "branch.$BRANCH.rebase" true
echo
echo "Summary of actions:"
echo "- A new remote tracking branch '$BRANCH' was created"
echo "- You are now on branch '$BRANCH'"
echo
}
cmd_checkout() {
parse_args "$@"
if [ "$NAME" != "" ]; then
expand_nameprefix_arg
git_do checkout "$BRANCH"
else
die "Name a feature branch explicitly."
fi
}
cmd_co() {
# Alias for checkout
cmd_checkout "$@"
}
cmd_rebase() {
DEFINE_boolean interactive false 'do an interactive rebase' i
parse_args "$@"
expand_nameprefix_arg_or_current
warn "Will try to rebase '$NAME'..."
require_clean_working_tree
require_branch "$BRANCH"
has_tracked_branch && fail "Bad idea on shared branch."
git_do checkout -q "$BRANCH"
local OPTS=
if flag interactive; then
OPTS="$OPTS -i"
fi
git_do rebase $OPTS "$DEVELOP_BRANCH"
}
avoid_accidental_cross_branch_action() {
local current_branch=$(git_current_branch)
if [ "$BRANCH" != "$current_branch" ]; then
warn "Trying to pull from '$BRANCH' while currently on branch '$current_branch'."
warn "To avoid unintended merges, git-flow aborted."
return 1
fi
return 0
}
cmd_pull() {
#DEFINE_string prefix false 'alternative remote feature branch name prefix' p
DEFINE_boolean rebase false "pull with rebase" r
parse_remote_name "$@"
if [ -z "$REMOTE" ]; then
die "Name a remote explicitly."
fi
name_or_current
# To avoid accidentally merging different feature branches into each other,
# die if the current feature branch differs from the requested $NAME
# argument.
local current_branch=$(git_current_branch)
if startswith "$current_branch" "$PREFIX"; then
# we are on a local feature branch already, so $BRANCH must be equal to
# the current branch
avoid_accidental_cross_branch_action || die
fi
require_clean_working_tree
if git_branch_exists "$BRANCH"; then
# Again, avoid accidental merges
avoid_accidental_cross_branch_action || die
# we already have a local branch called like this, so simply pull the
# remote changes in
if flag rebase; then
if ! git_do pull --rebase -q "$REMOTE" "$BRANCH"; then
warn "Pull was aborted. There might be conflicts during rebase or '$REMOTE' might be inaccessible."
exit 1
fi
else
git_do pull -q "$REMOTE" "$BRANCH" || die "Failed to pull from remote '$REMOTE'."
fi
echo "Pulled $REMOTE's changes into $BRANCH."
else
# setup the local branch clone for the first time
git_do fetch -q "$REMOTE" "$BRANCH" || die "Fetch failed." # stores in FETCH_HEAD
git_do branch --no-track "$BRANCH" FETCH_HEAD || die "Branch failed."
git_do checkout -q "$BRANCH" || die "Checking out new local branch failed."
echo "Created local branch $BRANCH based on $REMOTE's $BRANCH."
fi
}
fail() {
echo >&2
echo >&2 "*** ERROR: $1"
exit 128
}
commit_message () {
git cat-file commit "$1" | sed "1,/^$/d"
}
git_get_first_feature_branch_commit () {
git rev-list --first-parent "$1" ^"$ORIGIN/$DEVELOP_BRANCH" | tail -n 1
}
git_is_feature_branch_empty () {
if [ -z $(git_get_first_feature_branch_commit "$1") ]; then
return 0
else
return 1
fi
}
git_is_commit_on_branch () { # commit branch
if test "$(git merge-base $2 $1)" == "$(git rev-parse $1)"; then
return 0
else
return 1
fi
}
require_feature_branch() {
require_branch "$1"
first_feature_commit=$(git_get_first_feature_branch_commit "$1")
if [ -z "$first_feature_commit" ]; then
if ! git_is_commit_on_branch "$1" "$ORIGIN/$DEVELOP_BRANCH"; then
die "Current branch did NOT initially branch from '$ORIGIN/$DEVELOP_BRANCH'"
fi
else
if [[ "`git rev-list $first_feature_commit^ ^"$ORIGIN/$DEVELOP_BRANCH" 2>&1 | wc -l`" != "0" \
&& "`git rev-parse $first_feature_commit^`" != "`git rev-parse $ORIGIN/$DEVELOP_BRANCH^`" ]]; then
die "Current branch did NOT initially branch from '$ORIGIN/$DEVELOP_BRANCH'"
fi
fi
}
git_change_id() {
local change_id=$(commit_message "$1" | sed -n 's/^Change-Id:\s\+\(I[a-fA-F0-9]\+\)\s*$/\1/p' | tr "A-F" "a-f")
[ "$change_id" ] || return 1
echo "$change_id"
}
git_derived_change_id() {
local change_id=$(git_change_id "$2") || return 1
local tr=
case "$1" in
review) tr=1032547698badcfe ;; # xor 11..
message) tr=23016745ab89efcd ;; # xor 22..
*) fail "derived_change_id: wrong type" ;;
esac
echo "$change_id" | tr "0123456789abcdef" "$tr"
}
replace_change_id() {
sed '/^Change-Id:/d' | sed -e :a -e '/^\n*$/{$d;N;};/\n$/ba';
[ "$1" ] && echo && echo "Change-Id: $1"
}
git_symbolic_head() {
local HEAD=$(git symbolic-ref HEAD 2>/dev/null | sed -n 's,refs/heads/,,p')
[ "$HEAD" ] || HEAD=$(git rev-parse HEAD)
echo "$HEAD"
}
git_is_clean_merge() {
git merge --no-commit --no-ff "$1" >/dev/null 2>/dev/null
local status=$?
git reset -q --hard
return $status
}
ask() {
local default=$(echo "$1" | tr 'NY' 'ny')
has $default n y || fail "ask: No default."
shift
local question="$@"
local answer=
until has "$answer" n y; do
echo -n "$question"
[ "$default" == "y" ] && echo -n " [Y/n] "
[ "$default" == "n" ] && echo -n " [y/N] "
read answer || die "Interrupted."
[ -z "$answer" ] && answer=$default
answer=$(echo "$answer" | tr 'NY' 'ny')
done
test "$answer" == "y"
}
nth_string () {
case "$1" in
*1[0-9]|*[04-9]) echo "$1"th;;
*1) echo "$1"st;;
*2) echo "$1"nd;;
*3) echo "$1"rd;;
esac
}
generate_squash_message() {
local commits=$(git log --reverse --no-merges --first-parent --pretty=format:%H "$BRANCH" ^"$ORIGIN/$DEVELOP_BRANCH")
local count=$(echo "$commits" | wc -l)
[ "$count" -eq 0 ] && return 1
[ "$count" -eq 1 ] && {
commit_message "$commits" | sed '/^Change-Id:/d'
return 0
}
echo "# This is a combination of $count commits."
local i=0
while [ "$i" -lt "$count" ]; do
((i++))
echo "# The $(nth_string $i) commit's message is:"
echo
commit_message "$(echo "$commits" | sed -n "$i p")" | sed '/^Change-Id:/d'
done
# If more than one commits are squashed, add stripped commit template in the end.
local template=$(git config commit.template)
if [ -f "$template" ]; then
echo
cat "$template" | sed '/^\s*#/d;/^\s*$/d'
fi
}
get_feature_commit_message() {
# Find the first commit of the feature branch
local first_feature_commit=$(git_get_first_feature_branch_commit "$BRANCH")
[ "$first_feature_commit" ] || die "Aborting: $BRANCH contains no commits on top of $ORIGIN/$DEVELOP_BRANCH."
# The Gerrit Change-Id for the whole feature is _derived_ from the first commit
local first_change_id=$(git_change_id "$first_feature_commit") || fail "First commit in feature branch doesn't contain a Change-Id"
local feature_change_id=$(git_derived_change_id review "$first_feature_commit")
local message_change_id=$(git_derived_change_id message "$first_feature_commit")
# If there is a commit in the feature branch with 'message_change_id', use that for the squash commit message
local feature_message_commit=$(git log -1 --pretty=format:%H --grep="^Change-Id: $message_change_id" "$BRANCH" ^"$ORIGIN/$DEVELOP_BRANCH")
if [ "$feature_message_commit" ]; then
local commit_message=$(commit_message "$feature_message_commit")
else
# Commit message has not been edited yet -> generate from all commits in feature branch
local commit_message=$(generate_squash_message)
fi
echo "$commit_message" | replace_change_id "$feature_change_id"
}
edit_feature_commit_message() {
local first_feature_commit=$(git_get_first_feature_branch_commit "$BRANCH")
[ "$first_feature_commit" ] || die "Aborting: $BRANCH contains no commits on top of $DEVELOP_BRANCH."
# The Gerrit Change-Id for the whole feature is _derived_ from the first commit
local first_change_id=$(git_change_id "$first_feature_commit") || fail "First commit in feature branch doesn't contain a Change-Id"
local feature_change_id=$(git_derived_change_id review "$first_feature_commit")
local message_change_id=$(git_derived_change_id message "$first_feature_commit")
local initial_commit_message=$(get_feature_commit_message | replace_change_id)
( echo "# This is the commit message for the entire feature branch you are submitting to Gerrit."
echo "# Changes made to this message will be recorded as a new commit in your feature branch."
echo ""
echo "$initial_commit_message") > $DOT_GIT_DIR/COMMIT_EDITMSG
# Create a commit with the initial commit message
git commit --quiet --allow-empty --file=$DOT_GIT_DIR/COMMIT_EDITMSG --edit || die "Submit aborted due to empty commit message."
if [ "$(commit_message HEAD | replace_change_id)" == "$initial_commit_message" ]; then
# Remove commit if nothing changes
git reset -q --hard HEAD^ # Commit message not changed, delete empty commit
else
# Replace change ID with message change id
commit_message HEAD | replace_change_id "$message_change_id" | git commit --amend --quiet --allow-empty --file=-
fi
return 0
}
cmd_message() {
parse_args "$@"
expand_nameprefix_arg_or_current
require_feature_branch "$BRANCH"
require_clean_working_tree
init_restore_branch
git checkout -q "$BRANCH"
edit_feature_commit_message
}
cmd_info() {
parse_args "$@"
expand_nameprefix_arg_or_current
require_feature_branch "$BRANCH"
local first_feature_commit=$(git_get_first_feature_branch_commit "$BRANCH")
[ "$first_feature_commit" ] || die "Aborting: $BRANCH contains no commits on top of $DEVELOP_BRANCH."
# The Gerrit Change-Id for the whole feature is _derived_ from the first commit
local feature_change_id=$(git_derived_change_id review "$first_feature_commit")
info=$(gerrit_query "$feature_change_id") \
|| fail "Couldn't contact Gerrit to get the change url"
echo "change $feature_change_id"
echo "----------------------------------------------"
echo "$info"
}
cmd_submit() {
parse_args "$@"
expand_nameprefix_arg_or_current
require_feature_branch "$BRANCH"
require_clean_working_tree
# Ensure we return to the HEAD we were called from after this command completes (or fails)
HEAD=$(git_symbolic_head)
trap "git checkout -q $HEAD" INT TERM EXIT
git checkout -q "$BRANCH"
# If we are tracking a remote branch, require that they are equal
if has_tracked_branch; then
git fetch -q "$ORIGIN" "refs/heads/$REMOTE_BRANCH:refs/remotes/$ORIGIN/$REMOTE_BRANCH"
git_compare_branches "$BRANCH" "remotes/$ORIGIN/$REMOTE_BRANCH"
if [[ $? -ne 0 && $? -ne 2 ]]; then
warn "The $ORIGIN/$BRANCH has changes that are not in the local branch."
warn "You should probably pull to get these changes before submitting."
ask Y "Abort now?" && die "Ok."
fi
fi
if has "$ORIGIN/$DEVELOP_BRANCH" $(git_remote_branches); then
git fetch -q "$ORIGIN" "refs/heads/$DEVELOP_BRANCH:refs/remotes/$ORIGIN/$DEVELOP_BRANCH" || \
fail "Couldn't fetch latest $DEVELOP_BRANCH from Gerrit"
fi
# Check if merge into develop would be clean, otherwise request to merge first
if has "$ORIGIN/$DEVELOP_BRANCH" $(git_remote_branches); then
if ! git_is_clean_merge "remotes/$ORIGIN/$DEVELOP_BRANCH"; then
warn "Merge with the latest develop would FAIL: Merge needed before submitting."
ask Y "Should I start the merge now so you can solve conflicts?" \
|| die "Submit cancelled. Please merge manually before submitting to Gerrit."
warn
warn "Merging with $ORIGIN/$DEVELOP_BRANCH"
warn " - When merge is completed, run 'git flow feature submit' again"
warn " - To abort the merge, run 'git reset --hard HEAD'"
warn
trap - INT TERM EXIT
git merge "remotes/$ORIGIN/$DEVELOP_BRANCH"
exit $?
fi
fi
# Edit message
edit_feature_commit_message || exit 1
# Move to detached head mode so our squash commit doesn't go on any branch
git checkout -q `git rev-parse "$BRANCH"` || fail "Failed to checkout detached head"
# Reset to the last merge point with develop branch, but keeping the differences staged
git reset --soft `git merge-base "remotes/$ORIGIN/$DEVELOP_BRANCH" "$BRANCH"` || fail "Failed to create change commit"
git_is_clean_working_tree && fail "Feature branch contains no changes compared to '$ORIGIN/$DEVELOP_BRANCH'"
# Commit squashed changes
get_feature_commit_message | git commit --quiet --cleanup=strip --file=-
detached_head=$(git rev-parse HEAD)
git checkout -q "$BRANCH"
# Push commit to gerrit for review
gerrit_push "$detached_head:refs/for/$DEVELOP_BRANCH" || fail "Failed to submit change to gerrit"
# Print Summary of actions
change_info=$(gerrit_query "commit:${detached_head}")
change_url=$(echo "$change_info" | gerrit_query_filter url)
change_id=$(echo "$change_info" | gerrit_query_filter id)
echo
echo "Summary of actions:"
echo "- All commits on you feature branch were squashed into one,"
echo " and the resulting commit was pushed to Gerrit for review:"
echo " Commit: $(git log -1 --no-color --pretty="format:(%h..) %s" "${detached_head}")"
echo " Change-Id: ${change_id}"
echo " Review: ${change_url}"
echo
}
cmd_review() {
parse_args "$@"
expand_nameprefix_arg_or_current
require_feature_branch "$BRANCH"
commit_head=$(git rev-parse HEAD)
# sanity checks
git fetch -q "$ORIGIN" "refs/heads/$REMOTE_BRANCH:refs/remotes/$ORIGIN/$REMOTE_BRANCH"
# is the remote branch present on the server
if ! has "$ORIGIN/$REMOTE_BRANCH" $(git_all_branches); then
warn "The $ORIGIN/$REMOTE_BRANCH does not exist on Gerrit."
warn "You should probably use git flow feature publish."
warn "Aborting "
die
fi