apocalypse/perl-dist-zilla-plugin-bitbucket

NAME

Dist::Zilla::Plugin::Bitbucket - Plugins to integrate Dist::Zilla with Bitbucket

VERSION

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

DESCRIPTION

This is a set of plugins for Dist::Zilla intended to more easily integrate Bitbucket in the dzil workflow.

The following is the list of the plugins shipped in this distribution:

• Dist::Zilla::Plugin::Bitbucket::Create

  Create Bitbucket repo on dzil new

• Dist::Zilla::Plugin::Bitbucket::Update

  Update Bitbucket repo info on release

• Dist::Zilla::Plugin::Bitbucket::Meta

  Add Bitbucket repo info to META.{yml,json}

Configuration

Configure git with your Bitbucket credentials:

$ git config --global bitbucket.user LoginName
$ git config --global bitbucket.password MySecretPassword

Alternatively you can install Config::Identity and write your credentials in the (optionally GPG-encrypted) ~/.bitbucket file as follows:

login LoginName
password MySecretPassword

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

ATTRIBUTES

remote

Specifies the git/hg remote name to use (default 'origin').

repo

Specifies the name of the Bitbucket repository to be created (by default the name of the dist is used). This can be a template, so something like the following will work:

repo = {{ lc $dist -> name }}

scm

Specifies the source code management system to use.

The possible choices are hg and git. It will be autodetected from the distribution root directory if not provided.

SUPPORT

Perldoc

You can find documentation for this module with the perldoc command.

perldoc Dist::Zilla::Plugin::Bitbucket

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

• MetaCPAN

  A modern, open-source CPAN search engine, useful to view POD in HTML format.

  http://metacpan.org/release/Dist-Zilla-Plugin-Bitbucket

• Search CPAN

  The default CPAN search engine, useful to view POD in HTML format.

  http://search.cpan.org/dist/Dist-Zilla-Plugin-Bitbucket

• RT: CPAN's Bug Tracker

  The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.

  http://rt.cpan.org/NoAuth/Bugs.html?Dist=Dist-Zilla-Plugin-Bitbucket

• AnnoCPAN

  The AnnoCPAN is a website that allows community annotations of Perl module documentation.

  http://annocpan.org/dist/Dist-Zilla-Plugin-Bitbucket

• CPAN Ratings

  The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.

  http://cpanratings.perl.org/d/Dist-Zilla-Plugin-Bitbucket

• CPAN Forum

  The CPAN Forum is a web forum for discussing Perl modules.

  http://cpanforum.com/dist/Dist-Zilla-Plugin-Bitbucket

• CPANTS

  The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

  http://cpants.cpanauthors.org/dist/overview/Dist-Zilla-Plugin-Bitbucket

• CPAN Testers

  The CPAN Testers is a network of smokers who run automated tests on uploaded CPAN distributions.

  http://www.cpantesters.org/distro/D/Dist-Zilla-Plugin-Bitbucket

• CPAN Testers Matrix

  The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

  http://matrix.cpantesters.org/?dist=Dist-Zilla-Plugin-Bitbucket

• CPAN Testers Dependencies

  The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

  http://deps.cpantesters.org/?module=Dist::Zilla::Plugin::Bitbucket

Email

You can email the author of this module at APOCAL at cpan.org asking for help with any problems you have.

Internet Relay Chat

You can get live help by using IRC ( Internet Relay Chat ). If you don't know what IRC is, please read this excellent guide: http://en.wikipedia.org/wiki/Internet_Relay_Chat. Please be courteous and patient when talking to us, as we might be busy or sleeping! You can join those networks/channels and get help:

• irc.perl.org

  You can connect to the server at 'irc.perl.org' and join this channel: #perl-help then talk to this person for help: Apocalypse.

• irc.freenode.net

  You can connect to the server at 'irc.freenode.net' and join this channel: #perl then talk to this person for help: Apocal.

• irc.efnet.org

  You can connect to the server at 'irc.efnet.org' and join this channel: #perl then talk to this person for help: Ap0cal.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-dist-zilla-plugin-bitbucket at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dist-Zilla-Plugin-Bitbucket. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

https://github.com/apocalypse/perl-dist-zilla-plugin-bitbucket

git clone https://github.com/apocalypse/perl-dist-zilla-plugin-bitbucket.git

AUTHOR

Apocalypse <[email protected]>

ACKNOWLEDGEMENTS

This dist was shamelessly copied from ALEXBIO's excellent Dist::Zilla::Plugin::GitHub :)

I didn't implement the PluginBundle nor the Command::gh modules as I didn't have a need for them. Please let me know if you want them!

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.