NAME

Dist::Zilla::Plugin::GitHub::Update - Update GitHub repo info on release

VERSION

version 0.17

SYNOPSIS

Configure git with your GitHub credentials:

    $ git config --global github.user LoginName
    $ git config --global github.password GitHubPassword

Alternatively, the GitHub login token can be used instead of the password (note that token-based login has been deprecated by GitHub):

    $ git config --global github.token GitHubToken

then, in your dist.ini:

    [GitHub::Update]
    repo = SomeRepo
    cpan = 1

DESCRIPTION

This Dist::Zilla plugin updates the information of the GitHub repository when dzil release is run.

ATTRIBUTES

repo

The name of the GitHub repository. By default the dist name (from dist.ini) is used.

cpan

The GitHub homepage field will be set to the CPAN page of the module if this option is set to true (default),

p3rl

The GitHub homepage field will be set to the p3rl.org shortened URL (e.g. http://p3rl.org/My::Module) if this option is set to true (default is false).

This takes precedence over the cpan option (if both are true, p3rl will be used).

metacpan

The GitHub homepage field will be set to the metacpan.org distribution URL (e.g. http://metacpan.org/release/My-Module) if this option is set to true (default is false).

This takes precedence over the cpan and p3rl options (if all three are true, metacpan will be used).

AUTHOR

Alessandro Ghedini <alexbio@cpan.org>

LICENSE AND COPYRIGHT

Copyright 2011 Alessandro Ghedini.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.