Dist::Zilla::Plugin::GitHub::Update - Update a GitHub repo's info on release
Configure git with your GitHub credentials:
$ git config --global github.user LoginName
$ git config --global github.password GitHubPassword
Alternatively you can install Config::Identity and write your credentials in the (optionally GPG-encrypted) ~/.github file as follows:
(if only the login name is set, the password will be asked interactively).
You can also generate an access token for "full control over repositories" by following these instructions,
then, in your dist.ini:
# default config
# to override the repo name
repo = SomeRepo
See "ATTRIBUTES" for more options.
This Dist::Zilla plugin updates the information of the GitHub repository when dzil release is run.
The name of the GitHub repository. By default the name will be extracted from the URL of the remote specified in the remote option, and if that fails the dist name (from dist.ini) is used. It can also be in the form user/repo when it belongs to another GitHub user/organization.
The name of the Git remote pointing to the GitHub repository ("origin" by default). This is used when trying to guess the repository name.
The GitHub homepage field will be set to the p3rl.org shortened URL (e.g. https://p3rl.org/Dist::Zilla::Plugin::GitHub) if this option is set to true (default is false).
The GitHub homepage field will be set to the metacpan.org distribution URL (e.g. https://metacpan.org/release/Dist-Zilla-Plugin-GitHub) if this option is set to true (default).
This takes precedence over the p3rl options (if both are true, metacpan will be used).
The GitHub homepage field will be set to the value present in the dist meta (e.g. the one set by other plugins) if this option is set to true (default is false). If no value is present in the dist meta, this option is ignored.
This takes precedence over the metacpan and p3rl options (if all three are true, meta_home will be used).
Prompt for GitHub two-factor authentication code if this option is set to true (default is false). If this option is set to false but GitHub requires 2fa for the login, it'll be automatically enabled.
Bugs may be submitted through the RT bug tracker (or bug-Dist-Zilla-Plugin-GitHub@rt.cpan.org).
There is also a mailing list available for users of this distribution, at http://dzil.org/#mailing-list.
There is also an irc channel available for users of this distribution, at #distzilla on irc.perl.org.
Alessandro Ghedini <firstname.lastname@example.org>
This software is copyright (c) 2011 by Alessandro Ghedini.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Dist::Zilla::Plugin::GitHub, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.