debian man page for dist::zilla::plugin::git::check

Dist::Zilla::Plugin::Git::Check(3pm)			User Contributed Perl Documentation		      Dist::Zilla::Plugin::Git::Check(3pm)

NAME
       Dist::Zilla::Plugin::Git::Check - check your git repository before releasing

VERSION
       version 1.121820

SYNOPSIS
       In your dist.ini:

	   [Git::Check]
	   allow_dirty = dist.ini
	   allow_dirty = README
	   changelog = Changes	    ; this is the default

DESCRIPTION
       This plugin checks that git is in a clean state before releasing. The following checks are performed before releasing:

       o   there should be no files in the index (staged copy)

       o   there should be no untracked files in the working copy

       o   the working copy should be clean. The files listed in "allow_dirty" can be modified locally, though.

       If those conditions are not met, the plugin will die, and the release will thus be aborted. This lets you fix the problems before
       continuing.

       The plugin accepts the following options:

       o   changelog - the name of your changelog file. defaults to Changes.

       o   allow_dirty - a file that is allowed to have local modifications.  This option may appear multiple times.  The default list is dist.ini
	   and the changelog file given by "changelog".  You can use "allow_dirty =" to prohibit all local modifications.

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.

perl v5.14.2							    2012-06-30				      Dist::Zilla::Plugin::Git::Check(3pm)