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
|
#
# 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::Commit;
{
$Dist::Zilla::Plugin::Git::Commit::VERSION = '1.121820';
}
# ABSTRACT: commit dirty files
use File::Temp qw{ tempfile };
use Git::Wrapper;
use Moose;
use MooseX::Has::Sugar;
use MooseX::Types::Moose qw{ Str };
use Path::Class::Dir ();
use Cwd;
use String::Formatter method_stringf => {
-as => '_format_string',
codes => {
c => sub { $_[0]->_get_changes },
d => sub { require DateTime;
DateTime->now(time_zone => $_[0]->time_zone)
->format_cldr($_[1] || 'dd-MMM-yyyy') },
n => sub { "\n" },
N => sub { $_[0]->zilla->name },
t => sub { $_[0]->zilla->is_trial
? (defined $_[1] ? $_[1] : '-TRIAL') : '' },
v => sub { $_[0]->zilla->version },
},
};
with 'Dist::Zilla::Role::AfterRelease';
with 'Dist::Zilla::Role::Git::DirtyFiles';
with 'Dist::Zilla::Role::Git::Repo';
# -- attributes
has commit_msg => ( ro, isa=>Str, default => 'v%v%n%n%c' );
has time_zone => ( ro, isa=>Str, default => 'local' );
has add_files_in => ( ro, isa=>'ArrayRef[Str]', default => sub { [] } );
# -- public methods
sub mvp_multivalue_args { qw( add_files_in ) }
sub after_release {
my $self = shift;
my $git = Git::Wrapper->new( $self->repo_root );
my @output;
# check if there are dirty files that need to be committed.
# at this time, we know that only those 2 files may remain modified,
# otherwise before_release would have failed, ending the release
# process.
@output = sort { lc $a cmp lc $b } $self->list_dirty_files($git, 1);
# add any other untracked files to the commit list
if ( @{ $self->add_files_in } ) {
my @untracked_files = $git->ls_files( { others=>1, 'exclude-standard'=>1 } );
foreach my $f ( @untracked_files ) {
foreach my $path ( @{ $self->add_files_in } ) {
if ( Path::Class::Dir->new( $path )->subsumes( $f ) ) {
push( @output, $f );
last;
}
}
}
}
# if nothing to commit, we're done!
return unless @output;
# write commit message in a temp file
my ($fh, $filename) = tempfile( getcwd . '/DZP-git.XXXX', UNLINK => 1 );
print $fh $self->get_commit_message;
close $fh;
# commit the files in git
$git->add( @output );
$self->log_debug($_) for $git->commit( { file=>$filename } );
$self->log("Committed @output");
}
sub get_commit_message {
my $self = shift;
return _format_string($self->commit_msg, $self);
} # end get_commit_message
# -- private methods
sub _get_changes {
my $self = shift;
# parse changelog to find commit message
my $changelog = Dist::Zilla::File::OnDisk->new( { name => $self->changelog } );
my $newver = $self->zilla->version;
my @content =
grep { /^$newver(?:\s+|$)/ ... /^\S/ } # from newver to un-indented
split /\n/, $changelog->content;
shift @content; # drop the version line
# drop unindented last line and trailing blank lines
pop @content while ( @content && $content[-1] =~ /^(?:\S|\s*$)/ );
# return commit message
return join("\n", @content, ''); # add a final \n
} # end _get_changes
1;
=pod
=head1 NAME
Dist::Zilla::Plugin::Git::Commit - commit dirty files
=head1 VERSION
version 1.121820
=head1 SYNOPSIS
In your F<dist.ini>:
[Git::Commit]
changelog = Changes ; this is the default
=head1 DESCRIPTION
Once the release is done, this plugin will record this fact in git by
committing changelog and F<dist.ini>. The commit message will be taken
from the changelog for this release. It will include lines between
the current version and timestamp and the next non-indented line.
The plugin accepts the following options:
=over 4
=item * changelog - the name of your changelog file. Defaults to F<Changes>.
=item * allow_dirty - a file that will be checked in if it is locally
modified. This option may appear multiple times. The default
list is F<dist.ini> and the changelog file given by C<changelog>.
=item * add_files_in - a path that will have its new files checked in.
This option may appear multiple times. This is used to add files
generated during build-time to the repository, for example. The default
list is empty.
Note: The files have to be generated between those phases: BeforeRelease
E<lt>-E<gt> AfterRelease, and after Git::Check + before Git::Commit.
=item * commit_msg - the commit message to use. Defaults to
C<v%v%n%n%c>, meaning the version number and the list of changes.
=item * time_zone - the time zone to use with C<%d>. Can be any
time zone name accepted by DateTime. Defaults to C<local>.
=back
You can use the following codes in commit_msg:
=over 4
=item C<%c>
The list of changes in the just-released version (read from C<changelog>).
=item C<%{dd-MMM-yyyy}d>
The current date. You can use any CLDR format supported by
L<DateTime>. A bare C<%d> means C<%{dd-MMM-yyyy}d>.
=item C<%n>
a newline
=item C<%N>
the distribution name
=item C<%{-TRIAL}t>
Expands to -TRIAL (or any other supplied string) if this is a trial
release, or the empty string if not. A bare C<%t> means C<%{-TRIAL}t>.
=item C<%v>
the distribution version
=back
=head1 METHODS
=head2 get_commit_message
This method returns the commit message. The default implementation
reads the Changes file to get the list of changes in the just-released version.
=for Pod::Coverage after_release mvp_multivalue_args
=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__
|