App::DocKnot::Update3pm

Usage

    use App::DocKnot::Update;
    my $update = App::DocKnot::Update->new(
        {
            metadata => 'docs/metadata',
            output   => 'docs/docknot.yaml',
        }
    );
    $update->update();
    $update->update_spin('/path/to/spin/input');

Requirements

Perl 5.24 or later and the modules Git::Repository, File::BaseDir, File::ShareDir, JSON::MaybeXS, Path::Iterator::Rule, Path::Tiny, Perl6::Slurp, and YAML::XS, all of which are available from CPAN.

Overview

This component of DocKnot updates package configuration from older versions. Currently, its main purpose is to convert from the JSON format used prior to DocKnot 4.0 to the current YAML syntax.

Class methods

new(ARGS)

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

metadata

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

output

The path to which to write the new YAML configuration. Default: docs/docknot.yaml relative to the current directory.

Instance methods

update()

Load the legacy JSON metadata and write out the YAML equivalent.

update_spin([PATH])

Update the input tree for App::DocKnot::Spin to follow current expectations. PATH is the path to the input tree, which defaults to the current directory if not given. If the input tree is the working tree for a Git repository, any changes are also registered with Git (but not committed).

Copyright and license

Copyright 2013-2022, 2024 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.