Marcel Grünauer > ShipIt-Step-Jaiku-0.01 > ShipIt::Step::Jaiku

Download:
ShipIt-Step-Jaiku-0.01.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.01   Source  

NAME ^

ShipIt::Step::Jaiku - ShipIt step to announce the upload on Jaiku

SYNOPSIS ^

None.

DESCRIPTION ^

This ShipIt step announces the upload to Jaiku.

To use it, just list it in your .shipit file. You might want to use it after the UploadCPAN step, as it is not a good idea to announce the upload before it has gone through - something might go wrong with the upload.

If this step fails - maybe Jaiku is down - a warning is issued, but the shipit process doesn't die. This is because you might have uploaded the distribution to CPAN already, and it would be a shame for the whole process to die just because you're not able to jaiku.

CONFIGURATION ^

In the .shipit file:

    jaiku.config = /path/to/config/file
    jaiku.distname = Foo-Bar
    jaiku.message = shipped %d %v - soon at %u

You have to define three configuration values for this step:

jaiku.config

This is the location of the file that contains the Jaiku username and userkey in YAML style. I keep mine in ~/.jaikurc. The first tilde is expanded to the user's home directory. An example file could look like this:

    username: foobar
    userkey: flurble

You can retrieve your userkey from http://api.jaiku.com/.

The reason not to keep the username and userkey in the .shipit file directly has to with security. The .shipit file will generally be in the distribution's base directory, so it is easy to make a mistake and to include it in the MANIFEST. This would lead to the userkey being published on CPAN.

jaiku.distname

This is the distribution's name.

jaiku.message

This is the message to send to Jaiku. You can use placholders, which will be expanded. The following placeholders are recognized:

%d

Will be expanded to the distribution name that you defined in jaiku.distname.

%u

Will be expanded to the distribution's CPAN URL - if the distribution name is Foo-Bar, for example, the URL will be http://search.cpan.org/dist/Foo-Bar.

%v

Will be expanded to the version of the distribution you're shipping.

%%

Will result in a percent sign.

TAGS ^

If you talk about this module in blogs, on del.icio.us or anywhere else, please use the shipitstepjaiku tag.

VERSION ^

This document describes version 0.01 of ShipIt::Step::Jaiku.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to <bug-shipit-step-jaiku@rt.cpan.org>, or through the web interface at http://rt.cpan.org.

INSTALLATION ^

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY ^

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>.

AUTHOR ^

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright 2007 by Marcel Grünauer

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

syntax highlighting: