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::gatherdir(3pm) [debian man page]

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

NAME

       Dist::Zilla::Plugin::Git::GatherDir - gather all tracked files in a Git working directory

VERSION

       version 1.121820

DESCRIPTION

       This is a trivial variant of the GatherDir plugin.  It looks in the directory named in the "root" attribute and adds all the Git tracked
       files it finds there (as determined by "git ls-files").	If the root begins with a tilde, the tilde is replaced with the current user's
       home directory according to File::HomeDir.

       Most users just need:

	 [Git::GatherDir]

       ...and this will pick up all tracked files from the current directory into the dist.  You can use it multiple times, as you can any other
       plugin, by providing a plugin name.  For example, if you want to include external specification files into a subdir of your dist, you might
       write:

	 [Git::GatherDir]
	 ; this plugin needs no config and gathers most of your files

	 [Git::GatherDir / SpecFiles]
	 ; this plugin gets all tracked files in the root dir and adds them under ./spec
	 root	= ~/projects/my-project/spec
	 prefix = spec

ATTRIBUTES

   root
       This is the directory in which to look for files.  If not given, it defaults to the dist root -- generally, the place where your dist.ini
       or other configuration file is located.

   prefix
       This parameter can be set to gather all the files found under a common directory.  See the description above for an example.

   include_dotfiles
       By default, files will not be included if they begin with a dot.  This goes both for files and for directories relative to the "root".

       In almost all cases, the default value (false) is correct.

   follow_symlinks
       By default, directories that are symlinks will not be followed. Note on the other hand that in all followed directories, files which are
       symlinks are always gathered.

   exclude_filename
       To exclude certain files from being gathered, use the "exclude_filename" option. This may be used multiple times to specify multiple files
       to exclude.

   exclude_match
       This is just like "exclude_filename" but provides a regular expression pattern.	Files matching the pattern are not gathered.  This may be
       used multiple times to specify multiple patterns to exclude.

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

Check Out this Related Man Page

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

NAME

       Dist::Zilla::Plugin::Git::Commit - commit dirty files

VERSION

       version 1.121820

SYNOPSIS

       In your dist.ini:

	   [Git::Commit]
	   changelog = Changes	    ; this is the default

DESCRIPTION

       Once the release is done, this plugin will record this fact in git by committing changelog and dist.ini. The commit message will be taken
       from the changelog for this release.  It will include lines between the current version and timestamp and the next non-indented line.

       The plugin accepts the following options:

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

       o   allow_dirty - a file that will be checked in if it is locally modified.  This option may appear multiple times.  The default list is
	   dist.ini and the changelog file given by "changelog".

       o   add_files_in - a path that will have its new files checked in.  This option may appear multiple times. This is used to add files
	   generated during build-time to the repository, for example. The default list is empty.

	   Note: The files have to be generated between those phases: BeforeRelease <-> AfterRelease, and after Git::Check + before Git::Commit.

       o   commit_msg - the commit message to use. Defaults to "v%v%n%n%c", meaning the version number and the list of changes.

       o   time_zone - the time zone to use with %d.  Can be any time zone name accepted by DateTime.  Defaults to "local".

       You can use the following codes in commit_msg:

       %c  The list of changes in the just-released version (read from "changelog").

       "%{dd-MMM-yyyy}d"
	   The current date.  You can use any CLDR format supported by DateTime.  A bare %d means "%{dd-MMM-yyyy}d".

       %n  a newline

       %N  the distribution name

       "%{-TRIAL}t"
	   Expands to -TRIAL (or any other supplied string) if this is a trial release, or the empty string if not.  A bare %t means "%{-TRIAL}t".

       %v  the distribution version

METHODS

   get_commit_message
       This method returns the commit message.	The default implementation reads the Changes file to get the list of changes in the just-released
       version.

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::Commit(3pm)
Man Page