/ 
Dist-Zilla-Plugin-UsefulReadme-v0.5.1
/ Pod::Weaver::Section::RecentChanges

NAME

Pod::Weaver::Section::RecentChanges - generate POD with the recent changes

VERSION

version v0.5.1

SYNOPSIS

In the weaver.ini

[RecentChanges]
header    = RECENT CHANGES
changelog = Changes
region    = :readme

Or in the dist.ini for Dist::Zilla:

[PodWeaver]
[%PodWeaver]
RecentChanges.header    = RECENT CHANGES
RecentChanges.changelog = Changes
RecentChanges.region    = :readme

DESCRIPTION

This is a Pod::Weaver plugin to add a section with the changelog entries for the current version.

CONFIGURATION OPTIONS

The header to use. It defaults to "RECENT CHANGES".

changelog

The name of the change log. It defaults to "Changes".

If it is set to an empty string, and Dist::Zilla::Plugin::NextRelease is used, then it will use the update_filename from that plugin.

version

This is the release version to show.

The only reason to set this is if you need to specify the Dist::Zilla version placeholder because you want to insert the recent changes into the module POD, e.g.

version = {{$NEXT}}

region

When set to a non-empty string, the section will be embedded in a POD region, e.g.

region = :readme

to make the region available for Dist::Zilla::Plugin::UsefulReadme or Pod::Readme.

all_modules

When true, this section will be added to all modules in the distribution, and not just the main module.

When false (default), this section will only be added to the main module.

SEE ALSO

Dist::Zilla::Plugin::NextRelease

Pod::Weaver::Section::Changes

SUPPORT

Only the latest version of this module will be supported.

This module requires Perl v5.20 or later. Future releases may only support Perl versions released in the last ten years.

Reporting Bugs and Submitting Feature Requests

Please report any bugs or feature requests on the bugtracker website https://github.com/robrwo/perl-Dist-Zilla-Plugin-UsefulReadme/issues

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.

If the bug you are reporting has security implications which make it inappropriate to send to a public issue tracker, then see SECURITY.md for instructions how to report security vulnerabilities.

SOURCE

The development version is on github at https://github.com/robrwo/perl-Dist-Zilla-Plugin-UsefulReadme and may be cloned from git://github.com/robrwo/perl-Dist-Zilla-Plugin-UsefulReadme.git

AUTHOR

Robert Rothenberg <rrwo@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2025 by Robert Rothenberg.

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