App::DocKnot::Release - Release a distribution tarball
use App::DocKnot::Release;
my $docknot = App::DocKnot::Release->new();
$docknot->release();
Perl 5.24 or later and the modules File::BaseDir, File::ShareDir,
Git::Repository, Path::Tiny, and YAML::XS, all of which are available from
CPAN.
This component of DocKnot releases a distribution tarball (normally created by
"docknot dist" or App::DocKnot::Dist), maintains a software
distribution directory, and updates a version and release date database.
- new(ARGS)
- Create a new App::DocKnot::Release object. This should be
used for all subsequent actions. ARGS should be a hash reference with one
or more of the following keys:
- archivedir
- The release area into which to put the distribution
tarball. The current distribution will be put in a subdirectory named
after the "distribution.section" key in the package
configuration. Older versions will be moved to the ARCHIVE
subdirectory of archivedir. Required if not set in the global
configuration file.
- distdir
- The directory from which to get the new distribution
tarball, normally generated by "docknot dist". The latest
version in this directory will be used. Required if not set in the global
configuration file.
- metadata
- The path to the metadata for the package on which to
operate. Default: docs/docknot.yaml relative to the current
directory.
- release()
- Copy the distribution tarball (in multiple formats, with
PGP signatures) into a release area, updates symlink pointing to the
latest version, and move any old release to an archive area.
If "versions" is set in the global configuration file, updates the
.versions file found at that path with the new release version and
release date. See App::DocKnot::Spin::Versions for more information about
.versions files.
Russ Allbery <
[email protected]>
Copyright 2022 Russ Allbery <
[email protected]>
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.
docknot(1), App::DocKnot::Config, App::DocKnot::Dist,
App::DocKnot::Spin::Versions
This module is part of the App-DocKnot distribution. The current version of
DocKnot is available from CPAN, or directly from its web site at
<
https://www.eyrie.org/~eagle/software/docknot/>.