App::DocKnot::Config(3pm)

NAME
App::DocKnot::Config - Read and return DocKnot package configuration

SYNOPSIS
    use App::DocKnot::Config;
    my $reader = App::DocKnot::Config->new({ metadata => 'docs/docknot.yaml' });
    my $config = $reader->config();
    my $global_config = $reader->global_config();

REQUIREMENTS
Perl 5.24 or later and the modules File::BaseDir, File::ShareDir, Kwalify, and YAML::XS, all of which are available from CPAN.

DESCRIPTION
This component of DocKnot reads and returns the DocKnot global configuration and the configuration for a package. It takes as input a directory of metadata and returns either the global configuration or the package configuration as a hash.

The global configuration and additional metadata about specific licenses is loaded via File::BaseDir and therefore uses XDG paths by default. This means that the configuration and supplemental license metadata is found by searching the following paths in order:

1.  $XDG_CONFIG_HOME/docknot ($HOME/.config/docknot by default)

2.  $XDG_CONFIG_DIRS/docknot (/etc/xdg/docknot by default)

3.  Files included in the package.

The global configuration file should be named config.yaml in that directory. The license metadata should be named licenses.yaml.

Default license metadata is included with the App::DocKnot module and is used unless more specific configuration files exist. Be aware that, if such a configuration file exists, the data is not merged and only the configuration file is used.

CONFIGURATION

Global Configuration
The global configuration file ($HOME/.config/docknot/config.yaml by default) may contain the following keys:

archivedir
    Specifies the directory into which distribution tarballs are placed by the "docknot release" command. 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.

    If this is not specified, the -a option to "docknot release" is mandatory.

distdir
    Specifies the directory into which to build and store distribution tarballs (via the "docknot dist" command). Subdirectories of this directory are used as working directories while the distribution is being built, and the final tarballs are stored in this directory.

    If this is not specified, the -d options to "docknot dist" and "docknot release" is mandatory.

pgp_key
    Sign distribution tarballs generated via "docknot dist" with this PGP key. Equivalent to the -p option to "docknot dist".

versions
    Path to the .versions file that should be updated by "docknot release". A .versions file records the versions and release dates of software packages. See App::Docknot::Spin::Versions for more information.

CLASS METHODS

new(ARGS)
    Create a new App::DocKnot::Config 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 metadata for a package. Default: docs/docknot.yaml relative to the current directory.

INSTANCE METHODS

config()
    Load the metadata for the package and return it as a hash. The possible keys of this hash and the possible values are not yet documented.

global_config()
    Load the global DocKnot configuration and return it as a hash.

AUTHOR
Russ Allbery <rra@cpan.org>

COPYRIGHT AND LICENSE
Copyright 2013-2022 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), App::DocKnot::Dist, App::DocKnot::Release, 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/>.