The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

App::PerlReleaseUtils - Collection of utilities related to Perl distribution releases

VERSION

This document describes version 0.002 of App::PerlReleaseUtils (from Perl distribution App-PerlReleaseUtils), released on 2022-06-12.

SYNOPSIS

This distribution provides the following command-line utilities related to Perl distribution releases:

FUNCTIONS

grep_perl_release

Usage:

 grep_perl_release(%args) -> [$status_code, $reason, $payload, \%result_meta]

This function is not exported.

Arguments ('*' denotes required arguments):

  • exclude_latest_versions => posint

    Exclude latest N version(s) of each dist.

  • include_dev_release => bool (default: 1)

  • include_latest_versions => posint

    Only include latest N version(s) of each dist.

  • include_nondev_release => bool (default: 1)

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

FAQ

What is the purpose of this distribution? Haven't other similar utilities existed?

For example, mpath from Module::Path distribution is similar to pmpath in App::PMUtils, and mversion from Module::Version distribution is similar to pmversion from App::PMUtils distribution, and so on.

True. The main point of these utilities is shell tab completion, to save typing.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-PerlReleaseUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-PerlReleaseUtils.

SEE ALSO

Below is the list of distributions that provide CLI utilities for various purposes, with the focus on providing shell tab completion feature.

App::DistUtils, utilities related to Perl distributions.

App::DzilUtils, utilities related to Dist::Zilla.

App::GitUtils, utilities related to git.

App::IODUtils, utilities related to IOD configuration files.

App::LedgerUtils, utilities related to Ledger CLI files.

App::PerlReleaseUtils, utilities related to Perl distribution releases.

App::PlUtils, utilities related to Perl scripts.

App::PMUtils, utilities related to Perl modules.

App::ProgUtils, utilities related to programs.

App::WeaverUtils, utilities related to Pod::Weaver.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-PerlReleaseUtils

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.