/ 
Dist-Zilla-Plugin-Git-2.027
River stage three • 107 direct dependents • 134 total dependents
/ Dist::Zilla::Role::Git::DirtyFiles

NAME

Dist::Zilla::Role::Git::DirtyFiles - provide the allow_dirty & changelog attributes

VERSION

version 2.027

DESCRIPTION

This role is used within the git plugin to work with files that are dirty in the local git checkout.

ATTRIBUTES

allow_dirty

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.

If your repo_root is not the default (.), then these pathnames are relative to Dist::Zilla's root directory, not the Git root directory.

allow_dirty_match

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.

The paths being matched are relative to the Git root directory, even if your repo_root is not the default (.).

changelog

The name of the changelog. Defaults to Changes.

METHODS

list_dirty_files

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.

In scalar context, returns the number of dirty files.

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.