| Dist-Zilla-Plugin-Git documentation | Contained in the Dist-Zilla-Plugin-Git distribution. |
changelog.v%v%n%n%c, meaning the version number and the list of changes.%d. Can be any
time zone name accepted by DateTime. Defaults to local.
Dist::Zilla::Plugin::Git::Commit - commit dirty files
version 1.111590
In your dist.ini:
[Git::Commit]
changelog = Changes ; this is the default
Once the release is done, this plugin will record this fact in git by committing changelog and 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:
changelog.Note: The files have to be generated between those phases: BeforeRelease <-> AfterRelease, and after Git::Check + before Git::Commit.
v%v%n%n%c, meaning the version number and the list of changes.%d. Can be any
time zone name accepted by DateTime. Defaults to local.You can use the following codes in commit_msg:
%cThe list of changes in the just-released version (read from changelog).
%{dd-MMM-yyyy}dThe current date. You can use any CLDR format supported by
DateTime. A bare %d means %{dd-MMM-yyyy}d.
%na newline
%Nthe distribution name
%{-TRIAL}tExpands to -TRIAL (or any other supplied string) if this is a trial
release, or the empty string if not. A bare %t means %{-TRIAL}t.
%vthe distribution version
This method returns the commit message. The default implementation reads the Changes file to get the list of changes in the just-released version.
Jerome Quelin
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.
| Dist-Zilla-Plugin-Git documentation | Contained in the Dist-Zilla-Plugin-Git distribution. |
# # 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; BEGIN { $Dist::Zilla::Plugin::Git::Commit::VERSION = '1.111590'; } # 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 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'; # -- 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('.'); 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( '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;
__END__