NAME
Dist::Zilla::Plugin::SVK::Commit - commit dirty files
VERSION
version 0.10
SYNOPSIS
In your dist.ini:
[SVK::Commit]
changelog = Changes ; this is the default
DESCRIPTION
Once the release is done, this plugin will record this fact in svk 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 - the name of your changelog file. defaults to Changes.
allow_dirty - a file that will be checked in if it is locally modified. This option may appear multiple times. The default list is dist.ini and the changelog file given by
changelog
.commit_msg - the commit message to use. defaults to
v%v%n%n%c
, meaning the version number and the list of changes.
You can use the following codes in commit_msg:
%c
-
The list of changes in the just-released version (read from
changelog
). %{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
%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
Dr Bean <drbean at (a) cpan dot (.) org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2010 by Dr Bean.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.