Dist::Zilla::Role::Git::DirtyFiles - Provide the allow_dirty & changelog attributes
version 2.047
This role is used within the git plugin to work with files that are dirty in the local git checkout.
A list of paths that are allowed to be dirty in the git checkout. Defaults to dist.ini and the changelog (as defined per the changelog attribute.
dist.ini
changelog
If your repo_root is not the default (.), then these pathnames are relative to Dist::Zilla's root directory, not the Git root directory.
repo_root
.
A list of regular expressions that match paths allowed to be dirty in the git checkout. This is combined with allow_dirty. Defaults to the empty list.
allow_dirty
The paths being matched are relative to the Git root directory, even if your repo_root is not the default (.).
The name of the changelog. Defaults to Changes.
Changes
my @dirty = $plugin->list_dirty_files($git, $listAllowed);
This returns a list of the modified or deleted files in $git, filtered against the allow_dirty attribute. If $listAllowed is true, only allowed files are listed. If it's false, only files that are not allowed to be dirty are listed.
$git
$listAllowed
In scalar context, returns the number of dirty files.
Bugs may be submitted through the RT bug tracker (or bug-Dist-Zilla-Plugin-Git@rt.cpan.org).
There is also a mailing list available for users of this distribution, at http://dzil.org/#mailing-list.
There is also an irc channel available for users of this distribution, at #distzilla on irc.perl.org.
#distzilla
irc.perl.org
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.
To install Dist::Zilla::Plugin::Git, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dist::Zilla::Plugin::Git
CPAN shell
perl -MCPAN -e shell install Dist::Zilla::Plugin::Git
For more information on module installation, please visit the detailed CPAN module installation guide.