NAME

Dist::Zilla::Plugin::Bitbucket::Meta - Add a Bitbucket repo's info to META.{yml,json}

VERSION

This document describes v0.001 of Dist::Zilla::Plugin::Bitbucket::Meta - released November 03, 2014 as part of Dist-Zilla-Plugin-Bitbucket.

DESCRIPTION

# in dist.ini
[Bitbucket::Meta]

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

This module currently sets the following fields:

homepage

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

repository

web

URL pointing to the Bitbucket page of the project.

url

URL pointing to the Bitbucket repository (hg://...).

type

Either hg or git will be auto-detected and used.

bugtracker

web

URL pointing to the Bitbucket issues page of the project. If the bugs option is set to false (default is true) this will be skipped.

ATTRIBUTES

homepage

The META homepage field will be set to the Bitbucket repository's root if this option is set to true (default).

bugs

The META bugtracker web field will be set to the issue's page of the repository on Bitbucket, if this options is set to true (default).

NOTE: Be sure to enable the issues section in the repository's Bitbucket admin page!

wiki

The META homepage field will be set to the URL of the wiki of the Bitbucket repository, if this option is set to true (default is false).

NOTE: Be sure to enable the wiki section in the repository's Bitbucket admin page!

SEE ALSO

Please see those modules/websites for more information related to this module.

• Dist::Zilla::Plugin::Bitbucket

AUTHOR

Apocalypse <APOCAL@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Apocalypse.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

The full text of the license can be found in the LICENSE file included with this distribution.

DISCLAIMER OF WARRANTY

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.