• NAME
• VERSION
• SYNOPSIS
• DESCRIPTION
• ARGUMENTS
  • group
  • develop_branch
  • auto_previous_tag
  • release_branch
  • text
  • skip_file
  • skip_match
• AUTHOR
• COPYRIGHT AND LICENSE

NAME

Dist::Zilla::Plugin::ChangeStats::Git - add code churn statistics to the changelog

VERSION

version 0.6.0

SYNOPSIS

    In the dist.ini:

    [ChangeStats::Git]
    group=STATISTICS
    skip_match=^meta

DESCRIPTION

Adds a line to the changelog giving some stats about the code churn since the last release, which will look like:

  - code churn: 6 files changed, 111 insertions(+), 1 deletions(-)

ARGUMENTS

group

If given, the line is added to the specified group.

develop_branch

The master developing branch. Defaults to master.

auto_previous_tag

If enabled, look in the guts of the Dist::Zilla::Plugin::Git::Tag plugin in order to find the previous release's tag. This will be then compared against the develop_branch. Defaults to false (0).

release_branch

The branch recording the releases. Defaults to releases.

text

The text before git output. If it is a non-empty string, :<space> will be appended. Defaults to code churn.

skip_file

A complete path (from the distribution root) that should not be included in the statistics. Can be given multiple times.

skip_match

A part of a regex used to match against complete paths. Paths that match are not included in the statistics. Can be given multiple times.

AUTHOR

Yanick Champoux <yanick@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Yanick Champoux.

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

                    cpanm Dist::Zilla::Plugin::ChangeStats::Git

                    perl -MCPAN -e shell
                    install Dist::Zilla::Plugin::ChangeStats::Git