-
-
10 Jul 2021 01:27:44 UTC
- Distribution: Dist-Zilla-Plugin-Git
- Module version: 2.048
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues (18)
- Testers (899 / 0 / 0)
- Kwalitee
Bus factor: 3- 89.57% Coverage
- License: perl_5
- Perl: v5.10.0
- Activity
24 month- Tools
- Download (73.91KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 32 contributors- Jerome Quelin
-
Christopher J. Madsen
-
Jรฉrรดme Quelin
-
Kent Fredric
-
Yanick Champoux
-
Ricardo Signes
-
David Golden
-
Graham Knop
-
Mike Friedman
-
Chris Weyl
-
Stephen R. Scaffidi
-
Apocalypse
-
Curtis Jewell
-
Graham Barr
-
Mike Doherty
-
Randy Stauner
-
Alessandro Ghedini
-
Alexandr Ciornii
-
Brendan Byrd
-
Brian Phillips
-
David Steinbrunner
-
Geoffrey Broadwell
-
Harley Pig
-
Jesse Luehrs
-
Matt Follett
-
Michael McClimon
-
Michael Schout
-
Nigel Metheringham
-
Olivier Menguรฉ
-
Sean Whitton
-
Tatsuhiko Miyagawa
-
Tuomas Jormola
- Dependencies
- Cwd
- DateTime
- Dist::Zilla
- Dist::Zilla::Plugin::GatherDir
- Dist::Zilla::Role::AfterBuild
- Dist::Zilla::Role::AfterMint
- Dist::Zilla::Role::AfterRelease
- Dist::Zilla::Role::BeforeRelease
- Dist::Zilla::Role::FilePruner
- Dist::Zilla::Role::GitConfig
- Dist::Zilla::Role::PluginBundle
- Dist::Zilla::Role::VersionProvider
- File::Spec::Functions
- File::Temp
- File::chdir
- Git::Wrapper
- IPC::Open3
- IPC::System::Simple
- List::Util
- Module::Runtime
- Moose
- Moose::Role
- MooseX::Has::Sugar
- Path::Tiny
- String::Formatter
- Try::Tiny
- Type::Utils
- Types::Path::Tiny
- Types::Standard
- Version::Next
- constant
- namespace::autoclean
- strict
- version
- warnings
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Dist::Zilla::Plugin::Git::Check - Check your git repository before releasing
VERSION
version 2.048
SYNOPSIS
In your dist.ini:
[Git::Check] allow_dirty = dist.ini allow_dirty = README changelog = Changes ; this is the default build_warnings = 0 ; this is the default untracked_files = die ; default value (can also be "warn" or "ignore")
DESCRIPTION
This plugin checks that your Git repo 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 useallow_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.
build_warnings - if 1, perform the same checks after every build, but as warnings, not errors. Defaults to 0.
untracked_files - indicates what to do if there are untracked files. Must be either
die
(the default),warn
, orignore
.warn
lists the untracked files, whileignore
only prints the total number of untracked files.
SUPPORT
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
onirc.perl.org
.AUTHOR
Jerome Quelin
COPYRIGHT AND LICENCE
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.
Module Install Instructions
To install Dist::Zilla::Plugin::Git, copy and paste the appropriate command in to your terminal.
cpanm Dist::Zilla::Plugin::Git
perl -MCPAN -e shell install Dist::Zilla::Plugin::Git
For more information on module installation, please visit the detailed CPAN module installation guide.