Dist::Zilla::PluginBundle::GitHub(3)

NAME
Dist::Zilla::PluginBundle::GitHub - GitHub plugins all-in-one

VERSION
version 0.36

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:

    [@GitHub]
    repo = SomeRepo

DESCRIPTION
This bundle automatically adds all the GitHub plugins.

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.

"homepage"
    The META homepage field will be set to the value of the homepage field set on the GitHub repository's info if this option is set to true (default).

"wiki"
    The META homepage field will be set to the URL of the wiki of the GitHub repository, if this option is set to true (default is false) and if the GitHub Wiki happens to be activated (see the GitHub repository's "Admin" panel).

"bugs"
    The META bugtracker web field will be set to the issue's page of the repository on GitHub, if this options is set to true (default) and if the GitHub Issues happen to be activated (see the GitHub repository's "Admin" panel).

"fork"
    If the repository is a GitHub fork of another repository this option will make all the information be taken from the original repository instead of the forked one, if it's set to true (default).

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

SEE ALSO
Dist::Zilla::Plugin::GitHub::Meta, Dist::Zilla::Plugin::GitHub::Update

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.