/ 
Dist-Zilla-Plugin-Acme-CPANModules-0.005
River stage one • 1 direct dependent • 1 total dependent
/ Dist::Zilla::Plugin::Acme::CPANModules

NAME

Dist::Zilla::Plugin::Acme::CPANModules - Plugin to use when building Acme::CPANModules::* distribution

VERSION

This document describes version 0.005 of Dist::Zilla::Plugin::Acme::CPANModules (from Perl distribution Dist-Zilla-Plugin-Acme-CPANModules), released on 2022-04-01.

SYNOPSIS

In dist.ini:

[Acme::CPANModules]

DESCRIPTION

This plugin is to be used when building Acme::CPANModules::* distribution. It currently does the following.

For each Acme/CPANModules/*.pm file:

  • Check the list

    • Abort the build if there are no entries in $LIST

    • Abort the build if list does not have 'summary'

    • Warn if list summary does not begin with 'List of '

  • Fill the Abstract from list's summary

  • Add prereq to the listed modules (phase=x_lists, relationship=x_lists)

    Listed modules are modules that are specified in the module key of each entry.

  • Add prereq to the mentioned modules (phase=x_mentions, relationship=x_mentions)

    Mentioned modules are modules that are specified in the module key of each entry, as well as the alternate_modules and related_modules keys.

For each Acme/CPANModulesBundle/*.pm file:

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Dist-Zilla-Plugin-Acme-CPANModules.

SOURCE

Source repository is at https://github.com/perlancar/perl-Dist-Zilla-Plugin-Acme-CPANModules.

SEE ALSO

Acme::CPANModules

Pod::Weaver::Plugin::Acme::CPANModules

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, 2020, 2018 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=Dist-Zilla-Plugin-Acme-CPANModules

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.