NAME

Dist::Zilla::Plugin::Twitter - Twitter when you release with Dist::Zilla

VERSION

version 0.014

SYNOPSIS

In your dist.ini:

   [Twitter]
   hash_tags = #foo
   url_shortener = TinyURL

In your .netrc:

    machine api.twitter.com
      login YOUR_TWITTER_USER_NAME
      password YOUR_TWITTER_PASSWORD

DESCRIPTION

This plugin will use Net::Twitter with the login and password in your .netrc file to send a release notice to Twitter. By default, it will include a link to your README file as extracted on a fast CPAN mirror. This works very nicely with Dist::Zilla::Plugin::ReadmeFromPod.

The default configuration is as follows:

   [Twitter]
   tweet_url = http://cpan.cpantesters.org/authors/id/{{$AUTHOR_PATH}}/{{$DIST}}-{{$VERSION}}{{$TRIAL}}.readme
   tweet = Released {{$DIST}}-{{$VERSION}}{{$TRIAL}} {{$URL}}
   url_shortener = TinyURL

The tweet_url is shortened with WWW::Shorten::TinyURL or whichever other service you choose and appended to the tweet message. The following variables are available for substitution in the URL and message templates:

       DIST        # Foo-Bar
       ABSTRACT    # Foo-Bar is a module that FooBars
       VERSION     # 1.23
       TRIAL       # -TRIAL if is_trial, empty string otherwise.
       TARBALL     # Foo-Bar-1.23.tar.gz
       AUTHOR_UC   # JOHNDOE
       AUTHOR_LC   # johndoe
       AUTHOR_PATH # J/JO/JOHNDOE
       URL         # http://tinyurl.com/...

You must be using the UploadToCPAN or FakeRelease plugin for this plugin to determine your CPAN author ID.

You can use the hash_tags option to append hash tags (or anything, really) to the end of the message generated from tweet.

   [Twitter]
   hash_tags = #perl #cpan #foo

SUPPORT

Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker at http://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-Twitter. You will be notified automatically of any progress on your issue.

Source Code

This is open source software. The code repository is available for public review and contribution under the terms of the license.

https://github.com/dagolden/dist-zilla-plugin-twitter

  git clone https://github.com/dagolden/dist-zilla-plugin-twitter.git

AUTHOR

David Golden <dagolden@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2012 by David Golden.

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004

cpanm Dist::Zilla::Plugin::Twitter

perl -MCPAN -e shell
install Dist::Zilla::Plugin::Twitter