NAME

App::DocKnot::Dist - Prepare a distribution tarball

SYNOPSIS

    use App::DocKnot::Dist;
    my $docknot = App::DocKnot::Dist->new({ distdir => '/path/to/dist' });
    $docknot->make_distribution();

REQUIREMENTS

Perl 5.24 or later and the modules File::BaseDir, File::ShareDir, IPC::Run, IPC::System::Simple, JSON, and Perl6::Slurp, all of which are available from CPAN.

DESCRIPTION

This component of DocKnot generates distribution tarballs for a package. This is a bit of an odd inclusion in the DocKnot suite, since it's not about generating documentation, but it uses the same configuration and metadata as the rest of DocKnot.

Specifically, App::DocKnot::Dist exports the current branch from Git into a separate working directory, runs the commands appropriate to create a distribution (based on the build system configured in the package metadata), and cleans up the working directory.

CLASS METHODS

new(ARGS)

Create a new App::DocKnot::Dist object. This should be used for all subsequent actions. ARGS should be a hash reference with one or more of the following keys:

distdir

The path to the directory into which to put the distribution tarball. Required.

metadata

The path to the directory containing metadata for a package. Default: docs/metadata relative to the current directory.

perl

The path to the Perl executable to use for build steps that require it. Used primarily in the test suite. Default: The binary named perl on the user's PATH.

INSTANCE METHODS

commands()

Return the commands that should be run to generate a distribution tarball as a reference to an array of arrays. Each included array is a single command. This method is provided primarily for testing convenience and is normally just an implementation detail of make_distribution().

make_distribution()

Generate a distribution tarball in the destdir directory provided to new().

AUTHOR

Russ Allbery <rra@cpan.org>

COPYRIGHT AND LICENSE

Copyright 2019 Russ Allbery <rra@cpan.org>

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.

SEE ALSO

docknot(1)

This module is part of the App-DocKnot distribution. The current version of App::DocKnot is available from CPAN, or directly from its web site at https://www.eyrie.org/~eagle/software/docknot/.