Christopher J. Madsen > Dist-Zilla-Plugin-Git-2.023 > Dist::Zilla::Plugin::Git::Commit

Download:
Dist-Zilla-Plugin-Git-2.023.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  6
Open  12
View/Report Bugs
Module Version: 2.023   Source  

NAME ^

Dist::Zilla::Plugin::Git::Commit - commit dirty files

VERSION ^

version 2.023

SYNOPSIS ^

In your dist.ini:

    [Git::Commit]
    changelog = Changes      ; this is the default

DESCRIPTION ^

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, except that blank lines at the beginning or end are removed.

Warning: If you are using Git::Commit in conjunction with the NextRelease plugin, [NextRelease] must come before [Git::Commit] (or [@Git]) in your dist.ini or plugin bundle. Otherwise, Git::Commit will commit the Changes file before NextRelease has updated it.

The plugin accepts the following options:

You can use the following codes in commit_msg:

%c

The list of changes in the just-released version (read from changelog). It will include lines between the current version and timestamp and the next non-indented line, except that blank lines at the beginning or end are removed. It normally ends in a newline.

%{dd-MMM-yyyy}d

The current date. You can use any CLDR format supported by DateTime. A bare %d means %{dd-MMM-yyyy}d.

%n

a newline

%N

the distribution name

%{-TRIAL}t

Expands 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.

%v

the distribution version

METHODS ^

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.

AUTHOR ^

Jerome Quelin

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.

syntax highlighting: