The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Dist::Zilla::Plugin::GitObtain - obtain files from a git repository before building a distribution

VERSION

version 0.05

SYNOPSIS

In your dist.ini:

  [GitObtain]
    ;project    = url                                           tag
    rakudo      = git://github.com/rakudo/rakudo.git            2010.06
    http-daemon = git://gitorious.org/http-daemon/mainline.git

DESCRIPTION

This module uses Git::Wrapper to obtain files from git repositories before building a distribution.

You may specify the directory that git repositories will be placed into by following the plugin name (GitObtain) with a forward slash (/), then the path to the particular directory. For instance, if your dist.ini file contained the following section:

  [GitObtain/alpha/beta/gamma]
    ...

projects downloaded via git would be placed into the alpha/beta/gamma directory. This directory and any intermediate directories in the path will be created if they do not already exist. If you do not specify a path, then the git projects will be created in the current directory.

Following the section header is the list of git repositories to download and include in the distribution. Each repository is specified by the name of the directory in which the repository will be checked out, an equals sign (=), the URL to the git repository, and an optional "tag" to checkout (anything that may be passed to git checkout may be used for the "tag"). The repository directory will be created beneath the path specified in the section heading. So,

  [GitObtain/foo]
    my_project      = git://github.com/example/my_project.git
    another_project = git://github.com/example/another_project.git

will create a foo directory beneath the current directory and my_project and another_project directories inside of the foo directory. Each of the my_project and another_project directories will be git repositories.

AUTHOR

Jonathan Scott Duff <duff@pobox.com>

COPYRIGHT

This software is copyright (c) 2010 by Jonathan Scott Duff

This is free sofware; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language itself.