Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

dist::zilla::plugin::git::init(3pm) [debian man page]

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

NAME

       Dist::Zilla::Plugin::Git::Init - initialize git repository on dzil new

VERSION

       version 1.121820

SYNOPSIS

       In your profile.ini:

	   [Git::Init]
	   commit_message = initial commit  ; this is the default
	   remote = origin git@github.com:USERNAME/%{lc}N.git ; no default
	   config = user.email USERID@cpan.org	; there is no default

DESCRIPTION

       This plugin initializes a git repository when a new distribution is created with "dzil new".

   Plugin options
       The plugin accepts the following options:

       o   commit_message - the commit message to use when checking in the newly-minted dist. Defaults to "initial commit".

       o   config - a config setting to make in the repository.  No config entries are made by default.  A setting is specified as "OPTION VALUE".
	   This may be specified multiple times to add multiple entries.

       o   remote - a remote to add to the repository.	No remotes are added by default.  A remote is specified as "NAME URL".	This may be
	   specified multiple times to add multiple remotes.

   Formatting options
       You can use the following codes in "commit_message", "config", or "remote":

       %n  A newline.

       %N  The distribution name.  You can also use "%{lc}N" or "%{uc}N" to get the name in lower case or upper case, respectively.

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::Init(3pm)

Check Out this Related Man Page

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)
Man Page