.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "App::Sqitch::Command::bundle 3pm"
.TH App::Sqitch::Command::bundle 3pm 2024-02-08 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH Name
.IX Header "Name"
App::Sqitch::Command::bundle \- Bundle Sqitch changes for distribution
.SH Synopsis
.IX Header "Synopsis"
.Vb 2
\&  my $cmd = App::Sqitch::Command::bundle\->new(%params);
\&  $cmd\->execute;
.Ve
.SH Description
.IX Header "Description"
Bundles a Sqitch project for distribution. Done by creating a new directory
and copying the configuration file, plan file, and change files into it.
.SH Interface
.IX Header "Interface"
.SS Attributes
.IX Subsection "Attributes"
\fR\f(CI\*(C`from\*(C'\fR\fI\fR
.IX Subsection "from"
.PP
Change from which to build the bundled plan.
.PP
\fR\f(CI\*(C`to\*(C'\fR\fI\fR
.IX Subsection "to"
.PP
Change up to which to build the bundled plan.
.PP
\fR\f(CI\*(C`all\*(C'\fR\fI\fR
.IX Subsection "all"
.PP
Boolean indicating whether or not to run the command against all plans in the
project.
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fR\f(CI\*(C`execute\*(C'\fR\fI\fR
.IX Subsection "execute"
.PP
.Vb 1
\&  $bundle\->execute($command);
.Ve
.PP
Executes the \f(CW\*(C`bundle\*(C'\fR command.
.PP
\fR\f(CI\*(C`bundle_config\*(C'\fR\fI\fR
.IX Subsection "bundle_config"
.PP
.Vb 1
\& $bundle\->bundle_config;
.Ve
.PP
Copies the configuration file to the bundle directory.
.PP
\fR\f(CI\*(C`bundle_plan\*(C'\fR\fI\fR
.IX Subsection "bundle_plan"
.PP
.Vb 1
\& $bundle\->bundle_plan($target);
.Ve
.PP
Copies the plan file for the specified target to the bundle directory.
.PP
\fR\f(CI\*(C`bundle_scripts\*(C'\fR\fI\fR
.IX Subsection "bundle_scripts"
.PP
.Vb 1
\& $bundle\->bundle_scripts($target);
.Ve
.PP
Copies the deploy, revert, and verify scripts for each step in the plan for
the specified target to the bundle directory. Files in the script directories
that do not correspond to changes in the plan will not be copied.
.PP
\fR\f(CI\*(C`dest_top_dir\*(C'\fR\fI\fR
.IX Subsection "dest_top_dir"
.PP
.Vb 1
\&  my $top_dir = $bundle\->top_dir($target);
.Ve
.PP
Returns the destination top directory for the specified target.
.PP
\fR\f(CI\*(C`dest_dirs_for\*(C'\fR\fI\fR
.IX Subsection "dest_dirs_for"
.PP
.Vb 1
\&  my $dirs = $bundle\->dest_\|_dirs_for($target);
.Ve
.PP
Returns a hash of change script destination directories for the specified
target. The keys are the types of scripts, and include:
.ie n .IP """deploy""" 4
.el .IP \f(CWdeploy\fR 4
.IX Item "deploy"
.PD 0
.ie n .IP """revert""" 4
.el .IP \f(CWrevert\fR 4
.IX Item "revert"
.ie n .IP """verfiy""" 4
.el .IP \f(CWverfiy\fR 4
.IX Item "verfiy"
.ie n .IP """reworked_deploy""" 4
.el .IP \f(CWreworked_deploy\fR 4
.IX Item "reworked_deploy"
.ie n .IP """reworked_revert""" 4
.el .IP \f(CWreworked_revert\fR 4
.IX Item "reworked_revert"
.ie n .IP """reworked_verfiy""" 4
.el .IP \f(CWreworked_verfiy\fR 4
.IX Item "reworked_verfiy"
.PD
.SH "See Also"
.IX Header "See Also"
.IP sqitch-bundle 4
.IX Item "sqitch-bundle"
Documentation for the \f(CW\*(C`bundle\*(C'\fR command to the Sqitch command-line client.
.IP sqitch 4
.IX Item "sqitch"
The Sqitch command-line client.
.SH Author
.IX Header "Author"
David E. Wheeler <david@justatheory.com>
.SH License
.IX Header "License"
Copyright (c) 2012\-2024 iovation Inc., David E. Wheeler
.PP
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
.PP
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
.PP
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.