The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Dist-Zilla-Plugin-GitHub-0.37
River stage two • 23 direct dependents • 27 total dependents
16 ++
/ Dist::Zilla::Plugin::GitHub::Update

NAME

Dist::Zilla::Plugin::GitHub::Update - Update a GitHub repo's info on release

VERSION

version 0.37

SYNOPSIS

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:

    login LoginName
    password GitHubpassword

(if only the login name is set, the password will be asked interactively)

then, in your dist.ini:

    # default config
    [GitHub::Meta]

    # to override the repo name
    [GitHub::Meta]
    repo = SomeRepo

See "ATTRIBUTES" for more options.

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 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.

remote

The name of the Git remote pointing to the GitHub repository ("origin" by default). This is used when trying to guess the repository name.

cpan

The GitHub homepage field will be set to the CPAN page (search.cpan.org) 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).

meta_home

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, cpan and p3rl options (if all four are true, meta_home will be used).

prompt_2fa

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.

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.