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

NAME

Dist::Zilla::Plugin::GitHub::Meta - Add GitHub repo info to META.{yml,json}

VERSION

version 0.21

SYNOPSIS

Configure git with your GitHub credentials:

$ git config --global github.user LoginName

then, in your dist.ini:

[GitHub::Meta]
repo = SomeRepo

DESCRIPTION

This Dist::Zilla plugin adds some information about the distribution's GitHub repository to the META.{yml,json} files, using the official CPAN::Meta specification.

It currently sets the following fields:

  • homepage

    The official home of this project on the web, taken from the GitHub repository info. If the homepage option is set to false this will be skipped (default is true).

    When offline, this is not set.

  • repository

    • web

      URL pointing to the GitHub page of the project.

    • url

      URL pointing to the GitHub repository (git://...).

    • type

      This is set to git by default.

  • bugtracker

    • web

      URL pointing to the GitHub issues page of the project. If the bugs option is set to false (default is true) or the issues are disabled in the GitHub repository, this will be skipped.

      When offline, this is not set.

ATTRIBUTES

repo

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

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

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.