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
|
#
# This file is part of Dist-Zilla-Plugin-Git
#
# This software is copyright (c) 2009 by Jerome Quelin.
#
# This is free software; you can redistribute it and/or modify it under
# the same terms as the Perl 5 programming language system itself.
#
use 5.008;
use strict;
use warnings;
package Dist::Zilla::Plugin::Git::CommitBuild;
{
$Dist::Zilla::Plugin::Git::CommitBuild::VERSION = '1.121820';
}
# ABSTRACT: checkin build results on separate branch
use Git::Wrapper 0.021;
use IPC::Open3;
use IPC::System::Simple; # required for Fatalised/autodying system
use File::chdir;
use File::Spec::Functions qw/ rel2abs catfile /;
use File::Temp;
use Moose;
use namespace::autoclean;
use MooseX::AttributeShortcuts;
use Path::Class;
use MooseX::Types::Path::Class ':all';
use MooseX::Has::Sugar;
use MooseX::Types::Moose qw{ Str };
use Cwd qw(abs_path);
use Try::Tiny;
use String::Formatter (
method_stringf => {
-as => '_format_branch',
codes => {
b => sub { (shift->name_rev( '--name-only', 'HEAD' ))[0] },
},
},
method_stringf => {
-as => '_format_message',
codes => {
b => sub { (shift->_git->name_rev( '--name-only', 'HEAD' ))[0] },
h => sub { (shift->_git->rev_parse( '--short', 'HEAD' ))[0] },
H => sub { (shift->_git->rev_parse('HEAD'))[0] },
t => sub { shift->zilla->is_trial ? '-TRIAL' : '' },
v => sub { shift->zilla->version },
}
}
);
# debugging...
#use Smart::Comments '###';
with 'Dist::Zilla::Role::AfterBuild', 'Dist::Zilla::Role::AfterRelease';
with 'Dist::Zilla::Role::Git::Repo';
# -- attributes
has branch => ( ro, isa => Str, default => 'build/%b', required => 1 );
has release_branch => ( ro, isa => Str, required => 0 );
has message => ( ro, isa => Str, default => 'Build results of %h (on %b)', required => 1 );
has release_message => ( ro, isa => Str, lazy => 1, builder => '_build_release_message' );
has build_root => ( rw, coerce => 1, isa => Dir );
has _git => (rw, weak_ref => 1);
# -- attribute builders
sub _build_release_message { return shift->message; }
# -- role implementation
sub after_build {
my ( $self, $args) = @_;
# because the build_root mysteriously change at
# the 'after_release' stage
$self->build_root( $args->{build_root} );
$self->_commit_build( $args, $self->branch, $self->message );
}
sub after_release {
my ( $self, $args) = @_;
$self->_commit_build( $args, $self->release_branch, $self->release_message );
}
sub _commit_build {
my ( $self, undef, $branch, $message ) = @_;
return unless $branch;
my $tmp_dir = File::Temp->newdir( CLEANUP => 1) ;
my $src = Git::Wrapper->new( $self->repo_root );
$self->_git($src);
my $target_branch = _format_branch( $branch, $src );
my $dir = $self->build_root;
# returns the sha1 of the created tree object
my $tree = $self->_create_tree($src, $dir);
my ($last_build_tree) = try { $src->rev_parse("$target_branch^{tree}") };
$last_build_tree ||= 'none';
### $last_build_tree
if ($tree eq $last_build_tree) {
$self->log("No changes since the last build; not committing");
return;
}
my @parents = grep {
eval { $src->rev_parse({ 'q' => 1, 'verify'=>1}, $_ ) }
} $target_branch;
### @parents
my $this_message = _format_message( $message, $self );
my @commit = $src->commit_tree( { -STDIN => $this_message }, $tree, map { ( '-p' => $_) } @parents );
### @commit
$src->update_ref( 'refs/heads/' . $target_branch, $commit[0] );
}
sub _create_tree {
my ($self, $repo, $fs_obj) = @_;
### called with: "$fs_obj"
if (!$fs_obj->is_dir) {
my ($sha) = $repo->hash_object({ w => 1 }, "$fs_obj");
### hashed: "$sha $fs_obj"
return $sha;
}
my @entries;
for my $obj ($fs_obj->children) {
### working on: "$obj"
my $sha = $self->_create_tree($repo, $obj);
my $mode = sprintf('%o', $obj->stat->mode); # $obj->is_dir ? '040000' : '
my $type = $obj->is_dir ? 'tree' : 'blob';
my $name = $obj->basename;
push @entries, "$mode $type $sha\t$name";
}
### @entries
my ($sha) = $repo->mktree({ -STDIN => join("\n", @entries, q{}) });
return $sha;
}
1;
=pod
=head1 NAME
Dist::Zilla::Plugin::Git::CommitBuild - checkin build results on separate branch
=head1 VERSION
version 1.121820
=head1 SYNOPSIS
In your F<dist.ini>:
[Git::CommitBuild]
; these are the defaults
branch = build/%b
message = Build results of %h (on %b)
=head1 DESCRIPTION
Once the build is done, this plugin will commit the results of the
build to a branch that is completely separate from your regular code
branches (i.e. with a different root commit). This potentially makes
your repository more useful to those who may not have L<Dist::Zilla>
and all of its dependencies installed.
The plugin accepts the following options:
=over 4
=item * branch - L<String::Formatter> string for where to commit the
build contents.
A single formatting code (C<%b>) is defined for this attribute and will be
substituted with the name of the current branch in your git repository.
Defaults to C<build/%b>, but if set explicitly to an empty string
causes no build contents checkin to be made.
=item * release_branch - L<String::Formatter> string for where to commit the
build contents
Same as C<branch>, but commit the build content only after a release. No
default, meaning no release branch.
=item * message - L<String::Formatter> string for what commit message
to use when committing the results of the build.
This option supports five formatting codes:
=over 4
=item * C<%b> - Name of the current branch
=item * C<%H> - Commit hash
=item * C<%h> - Abbreviated commit hash
=item * C<%v> - The release version number
=item * C<%t> - The string "-TRIAL" if this is a trial release
=back
=item * release_message - L<String::Formatter> string for what
commit message to use when committing the results of the release.
Defaults to the same as C<message>.
=back
=for Pod::Coverage after_build
after_release
=head1 AUTHOR
Jerome Quelin
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2009 by Jerome Quelin.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
__END__
|