trusty (3) Dist::Zilla::Plugin::Git::Check.3pm.gz

Provided by: libdist-zilla-plugin-git-perl_2.019-1_all bug

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


VERSION
       version 2.019


SYNOPSIS
       In your dist.ini:

           [Git::Check]
           allow_dirty = dist.ini
           allow_dirty = README
           changelog = Changes      ; this is the default
           untracked_files = die    ; default value (can also be "warn" or "ignore")


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

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

       •   there should be no untracked files in the working copy

       •   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:

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

       •   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.

       •   allow_dirty_match - works the same as allow_dirty, but matching as a regular expression instead of an
           exact filename.

       •   untracked_files - indicates what to do if there are untracked files.  Must be either "die" (the
           default), "warn", or "ignore".  "warn" lists the untracked files, while "ignore" only prints the
           total number of untracked files.


AUTHOR
       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.