/ 
Dist-Zilla-Plugin-GitHub-0.01
River stage two • 23 direct dependents • 27 total dependents
/ Dist::Zilla::Plugin::GitHub::Update

NAME

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

VERSION

version 0.01

SYNOPSIS

In your dist.ini:

[GitHub::Update]
login  = LoginName
token  = GitHubToken
cpan = 1

DESCRIPTION

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

ATTRIBUTES

login

The GitHub login name. If not provided, will be used the value of github.user from the Git configuration, to set it, type:

$ git config --global github.user LoginName
token

The GitHub API token for the user. If not provided, will be used the value of github.token from the Git configuration, to set it, type:

$ git config --global github.token GitHubToken
cpan

If set to '1' (default), the GitHub homepage field will be set to the CPAN page of the module.

p3rl

If set to '1' (default '0'), the GitHub homepage field will be set to the p3rl.org shortened URL (e.g. http://p3rl.org/My::Module). This takes precedence over the cpan option (if both '1', p3rl will be used).

AUTHOR

Alessandro Ghedini <alexbio@cpan.org>

BUGS

Please report any bugs or feature requests at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dist-Zilla-Plugin-GitHub. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Dist::Zilla::Plugin::GitHub::Update

You can also look for information at:

SEE ALSO

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.