Chris Weyl > Dist-Zilla-Plugin-ContributorsFromGit-0.006 > Dist::Zilla::Plugin::ContributorsFromGit

Download:
Dist-Zilla-Plugin-ContributorsFromGit-0.006.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.006   Source   Latest Release: Dist-Zilla-Plugin-ContributorsFromGit-0.013

NAME ^

Dist::Zilla::Plugin::ContributorsFromGit - Populate your 'CONTRIBUTORS' POD from the list of git authors

VERSION ^

This document describes version 0.006 of Dist::Zilla::Plugin::ContributorsFromGit - released April 03, 2013 as part of Dist-Zilla-Plugin-ContributorsFromGit.

SYNOPSIS ^

    ; in your dist.ini
    [ContributorsFromGit]

    ; in your weaver.ini
    [Contributors]

DESCRIPTION ^

This plugin makes it easy to acknowledge the contributions of others by populating a %PodWeaver stash with the unique list of all git commit authors reachable from the current HEAD.

OVERVIEW ^

On collecting the unique list of reachable commit authors from git, we search and remove any git authors from the list of authors Dist::Zilla knows about. We then look for a stash named %PodWeaver; if we don't find one then we create an instance of Dist::Zilla::Stash::PodWeaver and register it with our zilla instance. Then we add the list of contributors (the filtered git authors list) to the stash in such a way that Pod::Weaver::Section::Contributors can find them.

Note that you do not need to have the %PodWeaver stash created; it will be added if it is not found. However, your Pod::Weaver config (aka c<weaver.ini>) must include the Contributors section plugin.

This plugin runs during the BeforeBuild phase.

The list of contributors is also added to distribution metadata under the custom x_contributors key.

If you have duplicate contributors because of differences in committer name or email you can use a .mailmap file to canonicalize contributor names and emails. See git help shortlog for details.

SEE ALSO ^

Please see those modules/websites for more information related to this module.

SOURCE ^

The development version is on github at http://github.com/RsrchBoy/Dist-Zilla-Plugin-ContributorsFromGit and may be cloned from git://github.com/RsrchBoy/Dist-Zilla-Plugin-ContributorsFromGit.git

BUGS ^

Please report any bugs or feature requests on the bugtracker website https://github.com/RsrchBoy/Dist-Zilla-Plugin-ContributorsFromGit/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.

AUTHOR ^

Chris Weyl <cweyl@alumni.drew.edu>

CONTRIBUTORS ^

COPYRIGHT AND LICENSE ^

This software is Copyright (c) 2012 by Chris Weyl.

This is free software, licensed under:

  The GNU Lesser General Public License, Version 2.1, February 1999
syntax highlighting: