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

Shipwright::Script::Import - Import sources and their dependencies

SYNOPSIS

shipwright import cpan:Jifty cpan:Catalyst

OPTIONS

-m [--comment] COMMENT         : specify the comment
--name NAME                    : specify the source name (only alphanumeric
                                 characters, . and -)
--as                           : the branch name
--build-script FILENAME        : specify the build script
--require-yml FILENAME         : specify the require.yml
--no-follow                    : don't follow the dependency chain
--extra-test FILENAME          : specify the extra test source
                                 (for --only-test when building)
--test-script FILENAME         : specify the test script (for --only-test when
                                 building)
--min-perl-version             : minimal perl version (default is the same as
                                 the one which runs this command)
--overwrite                    : import dependency sources anyway even if they
                                 are already in the shipyard
--version                      : specify the source's version
--skip                         : specify a list of sources not to import
--skip-recommends              : specify a list of sources of which recommends 
                                 not to import
--skip-all-recommends          : skip all the recommends to import
--skip-all-test-requires       : skip all the test requires to import
--skip-all-build-requires      : skip all the build requires to import
--skip-installed               : skip all the installed modules to import
--include-dual-lifed           : include modules which live both in the perl core 
                                 and on CPAN
--no-default-build             : don't try to detect and set build system

DESCRIPTION

The import command imports a new source into a shipyard from a number of supported source types (enumerated below). If a source of the name specified by --name already exists in the shipyard, the old files for that source in /sources and /scripts are deleted and new ones are added. This is the recommended method for updating non-svn, svk, or CPAN sources to new versions. (see Shipwright::Script::Update for more information on the update command, which is used for updating svn, svk, and CPAN dists).

SUPPORTED SOURCE TYPES

Generally, the format is type:schema; be careful, there is no blank between type and schema, just a colon.

CPAN

e.g. cpan:Jifty::DBI cpan:File::Spec

CAVEAT: we don't support renaming CPAN sources when importing, because it *really* is not a good idea and may hurt shipwright somewhere.

File

e.g. file:/home/sunnavy/foo-1.23.tar.gz file:/home/sunnavy/foo-1.23.tar.bz2 file:/home/sunnavy/foo-1.23.tgz

Directory

e.g. directory:/home/sunnavy/foo-1.23 dir:/home/sunnavy/foo-1.23

HTTP

e.g. http:http://example/foo-1.23.tar.gz

You can also omit one `http', like this:

http://example.com/foo-1.23.tar.gz

.tgz and .tar.bz2 are also supported.

FTP

e.g. ftp:ftp://example.com/foo-1.23.tar.gz ftp://example.com/foo-1.23.tar.gz

.tgz and .tar.bz2 are also supported.

SVK

e.g. svk://public/foo-1.23 svk:/local/foo-1.23

SVN

e.g. svn:file:///home/public/foo-1.23 svn:http://svn.example.com/foo-1.23

Git

e.g. git:file:///opt/foo.git git://github.com/bestpractical/shipwright.git

Shipyard

e.g. shipyard:/tmp/fs/foo

GLOBAL OPTIONS

-r [--repository] REPOSITORY   : specify the repository uri of our shipyard
-l [--log-level] LOGLEVEL      : specify the log level
                                 (info, debug, warn, error, or fatal)
--log-file FILENAME            : specify the log file

AUTHORS

sunnavy <sunnavy@bestpractical.com>

LICENCE AND COPYRIGHT

Shipwright is Copyright 2007-2015 Best Practical Solutions, LLC.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.