vendorificator 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +19 -0
- data/.travis.yml +9 -0
- data/Gemfile +11 -0
- data/LICENSE +22 -0
- data/README.md +45 -0
- data/Rakefile +29 -0
- data/bin/vendor +4 -0
- data/bin/vendorify +6 -0
- data/examples/Vendorfile +25 -0
- data/features/chef_cookbook.feature +44 -0
- data/features/deprecated.feature +17 -0
- data/features/fixtures/git/testrepo/HEAD +1 -0
- data/features/fixtures/git/testrepo/config +7 -0
- data/features/fixtures/git/testrepo/description +1 -0
- data/features/fixtures/git/testrepo/hooks/applypatch-msg.sample +15 -0
- data/features/fixtures/git/testrepo/hooks/commit-msg.sample +24 -0
- data/features/fixtures/git/testrepo/hooks/post-update.sample +8 -0
- data/features/fixtures/git/testrepo/hooks/pre-applypatch.sample +14 -0
- data/features/fixtures/git/testrepo/hooks/pre-commit.sample +50 -0
- data/features/fixtures/git/testrepo/hooks/pre-rebase.sample +169 -0
- data/features/fixtures/git/testrepo/hooks/prepare-commit-msg.sample +36 -0
- data/features/fixtures/git/testrepo/hooks/update.sample +128 -0
- data/features/fixtures/git/testrepo/info/exclude +6 -0
- data/features/fixtures/git/testrepo/info/refs +5 -0
- data/features/fixtures/git/testrepo/objects/info/packs +2 -0
- data/features/fixtures/git/testrepo/objects/pack/pack-46f7621b6a6b9b1c22dd15c08d457dfedf76e55f.idx +0 -0
- data/features/fixtures/git/testrepo/objects/pack/pack-46f7621b6a6b9b1c22dd15c08d457dfedf76e55f.pack +0 -0
- data/features/fixtures/git/testrepo/packed-refs +6 -0
- data/features/fixtures/git/testrepo/refs/heads/.sentinel +0 -0
- data/features/fixtures/git/testrepo/refs/tags/.sentinel +0 -0
- data/features/fixtures/vcr_cassettes/vendorificator.yml +2375 -0
- data/features/git.feature +12 -0
- data/features/needed.feature +16 -0
- data/features/smoke.feature +14 -0
- data/features/status.feature +47 -0
- data/features/step_definitions/basic.rb +52 -0
- data/features/step_definitions/git.rb +39 -0
- data/features/step_definitions/vendorificator.rb +27 -0
- data/features/support/env.rb +32 -0
- data/features/support/transform_pattern.rb +12 -0
- data/features/support/world_git.rb +40 -0
- data/features/support/world_runs.rb +90 -0
- data/features/tarball.feature +63 -0
- data/features/tarball_edit.feature +15 -0
- data/features/vendor.feature +16 -0
- data/lib/vendorificator/cli.rb +233 -0
- data/lib/vendorificator/config.rb +72 -0
- data/lib/vendorificator/hooks/chef_cookbook.rb +23 -0
- data/lib/vendorificator/repo.rb +69 -0
- data/lib/vendorificator/vendor/archive.rb +90 -0
- data/lib/vendorificator/vendor/chef_cookbook.rb +58 -0
- data/lib/vendorificator/vendor/git.rb +47 -0
- data/lib/vendorificator/vendor.rb +260 -0
- data/lib/vendorificator/version.rb +3 -0
- data/lib/vendorificator.rb +9 -0
- data/vendorificator.gemspec +30 -0
- metadata +321 -0
data/.gitignore
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2012 Maciej Pasternacki
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,45 @@
|
|
1
|
+
# Vendorificator
|
2
|
+
|
3
|
+
> **THIS WORK IS HEAVILY IN PROGRESS** and is far from usable yet. Sorry
|
4
|
+
about that - I'm working on it. Expect first usable version in January 2013.
|
5
|
+
|
6
|
+
## About
|
7
|
+
|
8
|
+
[Vendor everything](http://errtheblog.com/posts/50-vendor-everything). Keep your own copies of upstream dependencies that your project needs somewhere close to your project, best in the same source control repository. But how to do it, and keep track of all the upstream modules, their origin and license, upgrades, local changes, and so on? It's what Vendorificator helps you with.
|
9
|
+
|
10
|
+
Vendorificator keeps the upstream dependencies in your Git repository, using Git itself to help you with tracking all the updates, upgrades, and changes. You specify how to get the dependency in a config file written in plain Ruby, called `Vendorfile` (you don't need to know much Ruby to be able to write it - but you can use all Ruby you know if you want to!). Then you run `vendorify` command, and everything is done by magic:
|
11
|
+
|
12
|
+
* All of defined dependencies are downloaded to specified directories of your repository;
|
13
|
+
* Every dependency has its own pristine branch, to make it possible to cleanly upgrade the third-party module even if you have introduced your local changes;
|
14
|
+
* After every download and change of the pristine branch, the resulting commit is annotated with the details: timestamp, origin (including version, download checksum, and/or Git SHA-1), and any comments you might need to keep;
|
15
|
+
* You can easily upgrade the dependencies, change their origin for subsequent updates (projects do move around), add or remove them, etc;
|
16
|
+
* At any moment, you can get a list of third-party modules you use with its origin, version, timestamp, and list of your own patches;
|
17
|
+
* When you upgrade the dependency, you can easily review differences introduced to pristine copy by yourself, difference between old and new version, and merge the new version as you'd merge any regular Git branch.
|
18
|
+
|
19
|
+
All kinds of external dependencies you need - be it Ruby, Python, JavaScript, shell scripts, CSS libraries, Chef cookbooks, or any other modules you may need, are specified in a single place, and managed with a single tool.
|
20
|
+
|
21
|
+
## Installation
|
22
|
+
|
23
|
+
Add this line to your application's Gemfile:
|
24
|
+
|
25
|
+
gem 'vendorificator'
|
26
|
+
|
27
|
+
And then execute:
|
28
|
+
|
29
|
+
$ bundle
|
30
|
+
|
31
|
+
Or install it yourself as:
|
32
|
+
|
33
|
+
$ gem install vendorificator
|
34
|
+
|
35
|
+
## Usage
|
36
|
+
|
37
|
+
TODO: Write usage instructions here
|
38
|
+
|
39
|
+
## Contributing
|
40
|
+
|
41
|
+
1. Fork it
|
42
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
43
|
+
3. Commit your changes (`git commit -am 'Added some feature'`)
|
44
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
45
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
require "rubygems"
|
3
|
+
require "bundler"
|
4
|
+
Bundler.setup
|
5
|
+
|
6
|
+
require "bundler/gem_tasks"
|
7
|
+
|
8
|
+
namespace :relish do
|
9
|
+
desc "Publish documentation to Relish"
|
10
|
+
task :push do
|
11
|
+
sh "relish push 3ofcoins/vendorificator"
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
begin
|
16
|
+
require 'cucumber'
|
17
|
+
require 'cucumber/rake/task'
|
18
|
+
|
19
|
+
Cucumber::Rake::Task.new(:features) do |t|
|
20
|
+
t.cucumber_opts = "--format pretty --verbose"
|
21
|
+
end
|
22
|
+
rescue LoadError
|
23
|
+
desc 'Cucumber rake task not available'
|
24
|
+
task :features do
|
25
|
+
abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
task :default => :features
|
data/bin/vendor
ADDED
data/bin/vendorify
ADDED
data/examples/Vendorfile
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
# -*- ruby -*-
|
2
|
+
|
3
|
+
basedir 'vendor'
|
4
|
+
|
5
|
+
vendor 'generated', :version => '0.23' do |v|
|
6
|
+
# A generic vendor module.
|
7
|
+
# A directory #{root}/#{basedir}/generated has been created,
|
8
|
+
# we are now in this directory and should do whatever is needed
|
9
|
+
# to get this module here.
|
10
|
+
File.open('README') { |f| f.puts "Hello, World!" }
|
11
|
+
File.open('VERSION') { |f| f.puts v.version }
|
12
|
+
end
|
13
|
+
# attributes: version, path (defaults to name)
|
14
|
+
|
15
|
+
archive "http://ftp.gnu.org/gnu/hello/hello-2.8.tar.gz"
|
16
|
+
# name: hello-2.8
|
17
|
+
# strip_root: false
|
18
|
+
# type: tar.gz (recognized: tar.gz == tgz, tar.bz2, zip)
|
19
|
+
# version: nil
|
20
|
+
# checksum: automatically added
|
21
|
+
# download: via wget or given block
|
22
|
+
|
23
|
+
git "git://github.com/octocat/Hello-World.git"
|
24
|
+
# revision: nil (automatically locked at cloning)
|
25
|
+
# name: Hello-World
|
@@ -0,0 +1,44 @@
|
|
1
|
+
Feature: Chef cookbooks from Opscode Community website
|
2
|
+
|
3
|
+
Scenario: A single cookbook, without dependencies
|
4
|
+
|
5
|
+
Scenario: Version & checksum
|
6
|
+
Given a repository with following Vendorfile:
|
7
|
+
"""ruby
|
8
|
+
require 'vendorificator/vendor/chef_cookbook'
|
9
|
+
|
10
|
+
chef_cookbook 'apt'
|
11
|
+
"""
|
12
|
+
When I run "vendor"
|
13
|
+
Then following has been conjured:
|
14
|
+
| Name | cookbooks/apt |
|
15
|
+
| With file | metadata.rb |
|
16
|
+
|
17
|
+
Scenario: Dependency hook
|
18
|
+
Given a repository with following Vendorfile:
|
19
|
+
"""ruby
|
20
|
+
require 'vendorificator/vendor/chef_cookbook'
|
21
|
+
|
22
|
+
chef_cookbook 'memcached'
|
23
|
+
"""
|
24
|
+
When I run "vendor"
|
25
|
+
Then following has been conjured:
|
26
|
+
| Name | cookbooks/memcached | cookbooks/runit |
|
27
|
+
| With file | metadata.rb | metadata.rb |
|
28
|
+
|
29
|
+
Scenario: Ignored dependency
|
30
|
+
Given a repository with following Vendorfile:
|
31
|
+
"""ruby
|
32
|
+
require 'vendorificator/vendor/chef_cookbook'
|
33
|
+
|
34
|
+
chef_cookbook_ignore_dependencies ['runit']
|
35
|
+
|
36
|
+
chef_cookbook 'memcached'
|
37
|
+
"""
|
38
|
+
When I run "vendor"
|
39
|
+
Then following has been conjured:
|
40
|
+
| Name | cookbooks/memcached |
|
41
|
+
| With file | metadata.rb |
|
42
|
+
And following has not been conjured:
|
43
|
+
| Name | cookbooks/runit |
|
44
|
+
| With file | metadata.rb |
|
@@ -0,0 +1,17 @@
|
|
1
|
+
Feature: deprecation warnings
|
2
|
+
|
3
|
+
Background:
|
4
|
+
Given a repository with following Vendorfile:
|
5
|
+
"""ruby
|
6
|
+
vendor 'generated', :version => '0.23' do |v|
|
7
|
+
File.open('README', 'w') { |f| f.puts "Hello, World!" }
|
8
|
+
end
|
9
|
+
"""
|
10
|
+
|
11
|
+
Scenario: `vendorify` command prints a deprecation warning
|
12
|
+
When I run "vendorify"
|
13
|
+
Then command output includes "DEPRECATED: `vendorify` command is deprecated, run `vendor` instead"
|
14
|
+
|
15
|
+
Scenario: `vendor` command doesn't print a deprecation warning
|
16
|
+
When I run "vendor"
|
17
|
+
Then command output does not include "DEPRECATED: `vendorify` command is deprecated, run `vendor` instead"
|
@@ -0,0 +1 @@
|
|
1
|
+
ref: refs/heads/master
|
@@ -0,0 +1 @@
|
|
1
|
+
Unnamed repository; edit this file 'description' to name the repository.
|
@@ -0,0 +1,15 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# An example hook script to check the commit log message taken by
|
4
|
+
# applypatch from an e-mail message.
|
5
|
+
#
|
6
|
+
# The hook should exit with non-zero status after issuing an
|
7
|
+
# appropriate message if it wants to stop the commit. The hook is
|
8
|
+
# allowed to edit the commit message file.
|
9
|
+
#
|
10
|
+
# To enable this hook, rename this file to "applypatch-msg".
|
11
|
+
|
12
|
+
. git-sh-setup
|
13
|
+
test -x "$GIT_DIR/hooks/commit-msg" &&
|
14
|
+
exec "$GIT_DIR/hooks/commit-msg" ${1+"$@"}
|
15
|
+
:
|
@@ -0,0 +1,24 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# An example hook script to check the commit log message.
|
4
|
+
# Called by "git commit" with one argument, the name of the file
|
5
|
+
# that has the commit message. The hook should exit with non-zero
|
6
|
+
# status after issuing an appropriate message if it wants to stop the
|
7
|
+
# commit. The hook is allowed to edit the commit message file.
|
8
|
+
#
|
9
|
+
# To enable this hook, rename this file to "commit-msg".
|
10
|
+
|
11
|
+
# Uncomment the below to add a Signed-off-by line to the message.
|
12
|
+
# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
|
13
|
+
# hook is more suited to it.
|
14
|
+
#
|
15
|
+
# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
|
16
|
+
# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
|
17
|
+
|
18
|
+
# This example catches duplicate Signed-off-by lines.
|
19
|
+
|
20
|
+
test "" = "$(grep '^Signed-off-by: ' "$1" |
|
21
|
+
sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || {
|
22
|
+
echo >&2 Duplicate Signed-off-by lines.
|
23
|
+
exit 1
|
24
|
+
}
|
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# An example hook script to verify what is about to be committed
|
4
|
+
# by applypatch from an e-mail message.
|
5
|
+
#
|
6
|
+
# The hook should exit with non-zero status after issuing an
|
7
|
+
# appropriate message if it wants to stop the commit.
|
8
|
+
#
|
9
|
+
# To enable this hook, rename this file to "pre-applypatch".
|
10
|
+
|
11
|
+
. git-sh-setup
|
12
|
+
test -x "$GIT_DIR/hooks/pre-commit" &&
|
13
|
+
exec "$GIT_DIR/hooks/pre-commit" ${1+"$@"}
|
14
|
+
:
|
@@ -0,0 +1,50 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# An example hook script to verify what is about to be committed.
|
4
|
+
# Called by "git commit" with no arguments. The hook should
|
5
|
+
# exit with non-zero status after issuing an appropriate message if
|
6
|
+
# it wants to stop the commit.
|
7
|
+
#
|
8
|
+
# To enable this hook, rename this file to "pre-commit".
|
9
|
+
|
10
|
+
if git rev-parse --verify HEAD >/dev/null 2>&1
|
11
|
+
then
|
12
|
+
against=HEAD
|
13
|
+
else
|
14
|
+
# Initial commit: diff against an empty tree object
|
15
|
+
against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
|
16
|
+
fi
|
17
|
+
|
18
|
+
# If you want to allow non-ascii filenames set this variable to true.
|
19
|
+
allownonascii=$(git config hooks.allownonascii)
|
20
|
+
|
21
|
+
# Redirect output to stderr.
|
22
|
+
exec 1>&2
|
23
|
+
|
24
|
+
# Cross platform projects tend to avoid non-ascii filenames; prevent
|
25
|
+
# them from being added to the repository. We exploit the fact that the
|
26
|
+
# printable range starts at the space character and ends with tilde.
|
27
|
+
if [ "$allownonascii" != "true" ] &&
|
28
|
+
# Note that the use of brackets around a tr range is ok here, (it's
|
29
|
+
# even required, for portability to Solaris 10's /usr/bin/tr), since
|
30
|
+
# the square bracket bytes happen to fall in the designated range.
|
31
|
+
test $(git diff --cached --name-only --diff-filter=A -z $against |
|
32
|
+
LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
|
33
|
+
then
|
34
|
+
echo "Error: Attempt to add a non-ascii file name."
|
35
|
+
echo
|
36
|
+
echo "This can cause problems if you want to work"
|
37
|
+
echo "with people on other platforms."
|
38
|
+
echo
|
39
|
+
echo "To be portable it is advisable to rename the file ..."
|
40
|
+
echo
|
41
|
+
echo "If you know what you are doing you can disable this"
|
42
|
+
echo "check using:"
|
43
|
+
echo
|
44
|
+
echo " git config hooks.allownonascii true"
|
45
|
+
echo
|
46
|
+
exit 1
|
47
|
+
fi
|
48
|
+
|
49
|
+
# If there are whitespace errors, print the offending file names and fail.
|
50
|
+
exec git diff-index --check --cached $against --
|
@@ -0,0 +1,169 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# Copyright (c) 2006, 2008 Junio C Hamano
|
4
|
+
#
|
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
|
7
|
+
# non-zero status.
|
8
|
+
#
|
9
|
+
# The hook is called with the following parameters:
|
10
|
+
#
|
11
|
+
# $1 -- the upstream the series was forked from.
|
12
|
+
# $2 -- the branch being rebased (or empty when rebasing the current branch).
|
13
|
+
#
|
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.
|
17
|
+
|
18
|
+
publish=next
|
19
|
+
basebranch="$1"
|
20
|
+
if test "$#" = 2
|
21
|
+
then
|
22
|
+
topic="refs/heads/$2"
|
23
|
+
else
|
24
|
+
topic=`git symbolic-ref HEAD` ||
|
25
|
+
exit 0 ;# we do not interrupt rebasing detached HEAD
|
26
|
+
fi
|
27
|
+
|
28
|
+
case "$topic" in
|
29
|
+
refs/heads/??/*)
|
30
|
+
;;
|
31
|
+
*)
|
32
|
+
exit 0 ;# we do not interrupt others.
|
33
|
+
;;
|
34
|
+
esac
|
35
|
+
|
36
|
+
# Now we are dealing with a topic branch being rebased
|
37
|
+
# on top of master. Is it OK to rebase it?
|
38
|
+
|
39
|
+
# Does the topic really exist?
|
40
|
+
git show-ref -q "$topic" || {
|
41
|
+
echo >&2 "No such branch $topic"
|
42
|
+
exit 1
|
43
|
+
}
|
44
|
+
|
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"
|
48
|
+
then
|
49
|
+
echo >&2 "$topic is fully merged to master; better remove it."
|
50
|
+
exit 1 ;# we could allow it, but there is no point.
|
51
|
+
fi
|
52
|
+
|
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"
|
57
|
+
then
|
58
|
+
not_in_topic=`git rev-list "^$topic" master`
|
59
|
+
if test -z "$not_in_topic"
|
60
|
+
then
|
61
|
+
echo >&2 "$topic is already up-to-date with master"
|
62
|
+
exit 1 ;# we could allow it, but there is no point.
|
63
|
+
else
|
64
|
+
exit 0
|
65
|
+
fi
|
66
|
+
else
|
67
|
+
not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"`
|
68
|
+
/usr/bin/perl -e '
|
69
|
+
my $topic = $ARGV[0];
|
70
|
+
my $msg = "* $topic has commits already merged to public branch:\n";
|
71
|
+
my (%not_in_next) = map {
|
72
|
+
/^([0-9a-f]+) /;
|
73
|
+
($1 => 1);
|
74
|
+
} split(/\n/, $ARGV[1]);
|
75
|
+
for my $elem (map {
|
76
|
+
/^([0-9a-f]+) (.*)$/;
|
77
|
+
[$1 => $2];
|
78
|
+
} split(/\n/, $ARGV[2])) {
|
79
|
+
if (!exists $not_in_next{$elem->[0]}) {
|
80
|
+
if ($msg) {
|
81
|
+
print STDERR $msg;
|
82
|
+
undef $msg;
|
83
|
+
}
|
84
|
+
print STDERR " $elem->[1]\n";
|
85
|
+
}
|
86
|
+
}
|
87
|
+
' "$topic" "$not_in_next" "$not_in_master"
|
88
|
+
exit 1
|
89
|
+
fi
|
90
|
+
|
91
|
+
exit 0
|
92
|
+
|
93
|
+
################################################################
|
94
|
+
|
95
|
+
This sample hook safeguards topic branches that have been
|
96
|
+
published from being rewound.
|
97
|
+
|
98
|
+
The workflow assumed here is:
|
99
|
+
|
100
|
+
* Once a topic branch forks from "master", "master" is never
|
101
|
+
merged into it again (either directly or indirectly).
|
102
|
+
|
103
|
+
* Once a topic branch is fully cooked and merged into "master",
|
104
|
+
it is deleted. If you need to build on top of it to correct
|
105
|
+
earlier mistakes, a new topic branch is created by forking at
|
106
|
+
the tip of the "master". This is not strictly necessary, but
|
107
|
+
it makes it easier to keep your history simple.
|
108
|
+
|
109
|
+
* Whenever you need to test or publish your changes to topic
|
110
|
+
branches, merge them into "next" branch.
|
111
|
+
|
112
|
+
The script, being an example, hardcodes the publish branch name
|
113
|
+
to be "next", but it is trivial to make it configurable via
|
114
|
+
$GIT_DIR/config mechanism.
|
115
|
+
|
116
|
+
With this workflow, you would want to know:
|
117
|
+
|
118
|
+
(1) ... if a topic branch has ever been merged to "next". Young
|
119
|
+
topic branches can have stupid mistakes you would rather
|
120
|
+
clean up before publishing, and things that have not been
|
121
|
+
merged into other branches can be easily rebased without
|
122
|
+
affecting other people. But once it is published, you would
|
123
|
+
not want to rewind it.
|
124
|
+
|
125
|
+
(2) ... if a topic branch has been fully merged to "master".
|
126
|
+
Then you can delete it. More importantly, you should not
|
127
|
+
build on top of it -- other people may already want to
|
128
|
+
change things related to the topic as patches against your
|
129
|
+
"master", so if you need further changes, it is better to
|
130
|
+
fork the topic (perhaps with the same name) afresh from the
|
131
|
+
tip of "master".
|
132
|
+
|
133
|
+
Let's look at this example:
|
134
|
+
|
135
|
+
o---o---o---o---o---o---o---o---o---o "next"
|
136
|
+
/ / / /
|
137
|
+
/ a---a---b A / /
|
138
|
+
/ / / /
|
139
|
+
/ / c---c---c---c B /
|
140
|
+
/ / / \ /
|
141
|
+
/ / / b---b C \ /
|
142
|
+
/ / / / \ /
|
143
|
+
---o---o---o---o---o---o---o---o---o---o---o "master"
|
144
|
+
|
145
|
+
|
146
|
+
A, B and C are topic branches.
|
147
|
+
|
148
|
+
* A has one fix since it was merged up to "next".
|
149
|
+
|
150
|
+
* B has finished. It has been fully merged up to "master" and "next",
|
151
|
+
and is ready to be deleted.
|
152
|
+
|
153
|
+
* C has not merged to "next" at all.
|
154
|
+
|
155
|
+
We would want to allow C to be rebased, refuse A, and encourage
|
156
|
+
B to be deleted.
|
157
|
+
|
158
|
+
To compute (1):
|
159
|
+
|
160
|
+
git rev-list ^master ^topic next
|
161
|
+
git rev-list ^master next
|
162
|
+
|
163
|
+
if these match, topic has not merged in next at all.
|
164
|
+
|
165
|
+
To compute (2):
|
166
|
+
|
167
|
+
git rev-list master..topic
|
168
|
+
|
169
|
+
if this is empty, it is fully merged to "master".
|
@@ -0,0 +1,36 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# An example hook script to prepare the commit log message.
|
4
|
+
# Called by "git commit" with the name of the file that has the
|
5
|
+
# commit message, followed by the description of the commit
|
6
|
+
# message's source. The hook's purpose is to edit the commit
|
7
|
+
# message file. If the hook fails with a non-zero status,
|
8
|
+
# the commit is aborted.
|
9
|
+
#
|
10
|
+
# To enable this hook, rename this file to "prepare-commit-msg".
|
11
|
+
|
12
|
+
# This hook includes three examples. The first comments out the
|
13
|
+
# "Conflicts:" part of a merge commit.
|
14
|
+
#
|
15
|
+
# The second includes the output of "git diff --name-status -r"
|
16
|
+
# into the message, just before the "git status" output. It is
|
17
|
+
# commented because it doesn't cope with --amend or with squashed
|
18
|
+
# commits.
|
19
|
+
#
|
20
|
+
# The third example adds a Signed-off-by line to the message, that can
|
21
|
+
# still be edited. This is rarely a good idea.
|
22
|
+
|
23
|
+
case "$2,$3" in
|
24
|
+
merge,)
|
25
|
+
/usr/bin/perl -i.bak -ne 's/^/# /, s/^# #/#/ if /^Conflicts/ .. /#/; print' "$1" ;;
|
26
|
+
|
27
|
+
# ,|template,)
|
28
|
+
# /usr/bin/perl -i.bak -pe '
|
29
|
+
# print "\n" . `git diff --cached --name-status -r`
|
30
|
+
# if /^#/ && $first++ == 0' "$1" ;;
|
31
|
+
|
32
|
+
*) ;;
|
33
|
+
esac
|
34
|
+
|
35
|
+
# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
|
36
|
+
# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
|