3
# Copyright (c) 2006, 2008 Junio C Hamano
5
# The "pre-rebase" hook is run just before "git rebase" starts doing
6
# its job, and can prevent the command from running by exiting with
9
# The hook is called with the following parameters:
11
# $1 -- the upstream the series was forked from.
12
# $2 -- the branch being rebased (or empty when rebasing the current branch).
14
# This sample shows how to prevent topic branches that are already
15
# merged to 'next' branch from getting rebased, because allowing it
16
# would result in rebasing already published history.
24
topic=`git symbolic-ref HEAD` ||
25
exit 0 ;# we do not interrupt rebasing detached HEAD
32
exit 0 ;# we do not interrupt others.
36
# Now we are dealing with a topic branch being rebased
37
# on top of master. Is it OK to rebase it?
39
# Does the topic really exist?
40
git show-ref -q "$topic" || {
41
echo >&2 "No such branch $topic"
45
# Is topic fully merged to master?
46
not_in_master=`git rev-list --pretty=oneline ^master "$topic"`
47
if test -z "$not_in_master"
49
echo >&2 "$topic is fully merged to master; better remove it."
50
exit 1 ;# we could allow it, but there is no point.
53
# Is topic ever merged to next? If so you should not be rebasing it.
54
only_next_1=`git rev-list ^master "^$topic" ${publish} | sort`
55
only_next_2=`git rev-list ^master ${publish} | sort`
56
if test "$only_next_1" = "$only_next_2"
58
not_in_topic=`git rev-list "^$topic" master`
59
if test -z "$not_in_topic"
61
echo >&2 "$topic is already up-to-date with master"
62
exit 1 ;# we could allow it, but there is no point.
67
not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"`
70
my $msg = "* $topic has commits already merged to public branch:\n";
71
my (%not_in_next) = map {
74
} split(/\n/, $ARGV[1]);
78
} split(/\n/, $ARGV[2])) {
79
if (!exists $not_in_next{$elem->[0]}) {
84
print STDERR " $elem->[1]\n";
87
' "$topic" "$not_in_next" "$not_in_master"
94
################################################################
96
This sample hook safeguards topic branches that have been
97
published from being rewound.
99
The workflow assumed here is:
101
* Once a topic branch forks from "master", "master" is never
102
merged into it again (either directly or indirectly).
104
* Once a topic branch is fully cooked and merged into "master",
105
it is deleted. If you need to build on top of it to correct
106
earlier mistakes, a new topic branch is created by forking at
107
the tip of the "master". This is not strictly necessary, but
108
it makes it easier to keep your history simple.
110
* Whenever you need to test or publish your changes to topic
111
branches, merge them into "next" branch.
113
The script, being an example, hardcodes the publish branch name
114
to be "next", but it is trivial to make it configurable via
115
$GIT_DIR/config mechanism.
117
With this workflow, you would want to know:
119
(1) ... if a topic branch has ever been merged to "next". Young
120
topic branches can have stupid mistakes you would rather
121
clean up before publishing, and things that have not been
122
merged into other branches can be easily rebased without
123
affecting other people. But once it is published, you would
124
not want to rewind it.
126
(2) ... if a topic branch has been fully merged to "master".
127
Then you can delete it. More importantly, you should not
128
build on top of it -- other people may already want to
129
change things related to the topic as patches against your
130
"master", so if you need further changes, it is better to
131
fork the topic (perhaps with the same name) afresh from the
134
Let's look at this example:
136
o---o---o---o---o---o---o---o---o---o "next"
140
/ / c---c---c---c B /
144
---o---o---o---o---o---o---o---o---o---o---o "master"
147
A, B and C are topic branches.
149
* A has one fix since it was merged up to "next".
151
* B has finished. It has been fully merged up to "master" and "next",
152
and is ready to be deleted.
154
* C has not merged to "next" at all.
156
We would want to allow C to be rebased, refuse A, and encourage
161
git rev-list ^master ^topic next
162
git rev-list ^master next
164
if these match, topic has not merged in next at all.
168
git rev-list master..topic
170
if this is empty, it is fully merged to "master".
added
removed
src/sizzle/.git/hooks/pre-rebase.sample
