/ 
App-ModuleReleaseSelectUtils-0.001
River stage one • 1 direct dependent • 1 total dependent
/ App::ModuleReleaseSelectUtils

NAME

App::ModuleReleaseSelectUtils - Utilities related to Module::Release::Select

VERSION

This document describes version 0.001 of App::ModuleReleaseSelectUtils (from Perl distribution App-ModuleReleaseSelectUtils), released on 2023-03-09.

DESCRIPTION

This distribution contains the following CLI utilities:

FUNCTIONS

check_release_matches

Usage:

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

Given an expression and one or more releases, show which releases match the expression.

Examples:

  • Example #1:

    check_release_matches(expr => ">1.31", releases => [2.1]);

    Result:

    [
  200,
  "OK (matches)",
  "Release(s) match expression",
  { "cmdline.exit_code" => 0 },
]

  • Example #2:

    check_release_matches(expr => ">1.31", releases => [1.3]);

    Result:

    [
  200,
  "OK (no match)",
  "Release(s) do NOT match expression",
  { "cmdline.exit_code" => 1 },
]

  • Example #3:

    check_release_matches(expr => ">1.31", releases => [1.31]);

    Result:

    [
  200,
  "OK (no match)",
  "Release(s) do NOT match expression",
  { "cmdline.exit_code" => 1 },
]

  • Example #4:

    check_release_matches(expr => ">1.31", releases => [2.1, 1.32, 1.31, 1.3]);

    Result:

    [
  200,
  "OK (matches)",
  "Release(s) match expression",
  { "cmdline.exit_code" => 0 },
]

This function is not exported.

Arguments ('*' denotes required arguments):

  • expr* => str

    (No description)

  • quiet => bool

    (No description)

  • releases* => array[str]

    (No description)

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)

HOMEPAGE

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

SOURCE

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

SEE ALSO

Module::Release::Select

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, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023 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-ModuleReleaseSelectUtils

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.