Dist::Zilla::Plugin::ChangelogFromGit::CPAN::Changes - Generate valid CPAN::Changes Changelogs from git
version 0.230680
[ChangelogFromGit::CPAN::Changes]
; All options from [ChangelogFromGit] plus
group_by_author = 1 ; default 0
show_author_email = 1 ; default 0
show_author = 0 ; default 1
edit_changelog = 1 ; default 0
Whether to group commit messages by their author. This is the only way previous versions did it. Defaults to no, and [ Anne Author ] is appended to the commit message.
Defaults to off.
Author email is probably just noise for most people, but turn this on if you want to show it [ Anne Author [email protected] ]
Defaults to off.
Whether to show authors at all. Turning this off also turns off grouping by author and author emails.
Defaults to on.
A regexp string which will be used to match git tags to find releases. If your release tags are not compliant with CPAN::Changes::Spec, you can use a capture group. It will be used as the version in place of the full tag name.
Also takes semantic, which becomes qr{^v?(\d+\.\d+\.\d+)$}, and
decimal, which becomes qr{^v?(\d+\.\d+)$}.
Defaults to 'decimal'
The name of the changelog file.
Defaults to 'Changes'.
Block of text at the beginning of the changelog.
Defaults to 'Changelog for $dist_name'
When true, the generated changelog will be copied into the root folder where it can be committed (possiby automatically by Dist::Zilla::Plugin::Git::Commit)
Defaults to true.
When true, the generated changelog will be opened in an editor to allow manual editing.
Defaults to false.
You can find documentation for this module with the perldoc command.
perldoc Dist::Zilla::Plugin::ChangelogFromGit::CPAN::Changes
The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.
-
MetaCPAN
A modern, open-source CPAN search engine, useful to view POD in HTML format.
https://metacpan.org/release/Dist-Zilla-Plugin-ChangelogFromGit-CPAN-Changes
Please report any bugs or feature requests through the web interface at https://github.com/ioanrogers/Dist-Zilla-Plugin-ChangelogFromGit-CPAN-Changes.git/issues. You will be automatically notified of any progress on the request by the system.
The source code is available for from the following locations:
https://github.com/ioanrogers/Dist-Zilla-Plugin-ChangelogFromGit-CPAN-Changes.git
git clone https://github.com/ioanrogers/Dist-Zilla-Plugin-ChangelogFromGit-CPAN-Changes.git.git
Ioan Rogers [email protected]
This software is copyright (c) 2023 by Ioan Rogers.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.