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


Dist-Zilla-Plugin-Git documentation  | view source Contained in the Dist-Zilla-Plugin-Git distribution.

Index


NAME

Top

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

VERSION

Top

version 1.111590

DESCRIPTION

Top

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

ATTRIBUTES

Top

allow_dirty

A list of files that are allowed to be dirty in the git checkout. Defaults to dist.ini and the changelog (as defined per the changelog attribute.

changelog

The name of the changelog. Defaults to Changes.

METHODS

Top

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

Top

Jerome Quelin

COPYRIGHT AND LICENSE

Top


Dist-Zilla-Plugin-Git documentation  | view source Contained in the Dist-Zilla-Plugin-Git distribution.