.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Dist::Zilla::Plugin::Twitter 3pm" .TH Dist::Zilla::Plugin::Twitter 3pm "2022-06-13" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Dist::Zilla::Plugin::Twitter \- Twitter when you release with Dist::Zilla .SH "VERSION" .IX Header "VERSION" version 0.026 .SH "SYNOPSIS" .IX Header "SYNOPSIS" In your \fIdist.ini\fR: .PP .Vb 3 \& [Twitter] \& hash_tags = #foo \& url_shortener = TinyURL .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This plugin will use Net::Twitter to send a release notice to Twitter. By default, it will include a link to release on . .PP The default configuration is as follows: .PP .Vb 4 \& [Twitter] \& tweet_url = https://metacpan.org/release/{{$AUTHOR_UC}}/{{$DIST}}\-{{$VERSION}}/ \& tweet = Released {{$DIST}}\-{{$VERSION}}{{$TRIAL}} {{$URL}} !META{resources}{repository}{web} \& url_shortener = TinyURL .Ve .PP The \f(CW\*(C`tweet_url\*(C'\fR is shortened with WWW::Shorten::TinyURL or whichever other service you choose (use 'none' to use the full \s-1URL,\s0 in which case Twitter will shorten it for you) and appended to the \&\f(CW\*(C`tweet\*(C'\fR message. .SS "\s-1VARIABLE INTERPOLATION\s0" .IX Subsection "VARIABLE INTERPOLATION" The following variables are available for substitution in the \s-1URL\s0 and message templates: .PP .Vb 10 \& DIST # Foo\-Bar \& MODULE # 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/... .Ve .PP \fI\s-1DISTMETA INTERPOLATION\s0\fR .IX Subsection "DISTMETA INTERPOLATION" .PP Resources information available in the \s-1META\s0.* files of the distribution can be accessed via \f(CW\*(C`. You may mix-and-match \&\f(CW\*(C`{...}\*(C'\fR to access hashref elements and \f(CW\*(C`[\ed]\*(C'\fR to access arrayref elements. You're responsible for making sure you are accessing the right part of the \s-1META\s0 data structure, and treating it as the right type of data. See CPAN::Meta::Spec and the \*(L"$TYPE \s-1DATA\*(R"\s0 sections of CPAN::Meta in particular. .PP The \f(CW\*(C`META{...}\*(C'\fR replacement may also have one of two modifiers, which are prefixed directly before \f(CW\*(C`META\*(C'\fR: .ie n .IP """!"" \- \s-1URL\s0 shortening" 4 .el .IP "\f(CW!\fR \- \s-1URL\s0 shortening" 4 .IX Item "! - URL shortening" Providing an exclamation point (\f(CW\*(C`!META{...}\*(C'\fR) will URL-shorten the value you extract from the distmeta data structure. This will have no effect unless the value is a \s-1URL\s0 to begin with. .ie n .IP """@"" \- Arrayref stringification" 4 .el .IP "\f(CW@\fR \- Arrayref stringification" 4 .IX Item "@ - Arrayref stringification" Providing an at-symbol (\f(CW@META{...}\fR) will include all the elements of the arrayref you specify by joining them with \f(CW$"\fR. So, this is just like doing \f(CW"@{ $your_array_ref }"\fR. .PP So, for example, to use the GitHub home of the project instead of its metacpan page, one can do: .PP .Vb 3 \& [Twitter] \& tweet = Released {{$DIST}}\-{{$VERSION}}{{$TRIAL}} !META{resource}{repository}{web} \& url_shortener = TinyURL .Ve .PP Or, to include the authors in your tweet: .PP .Vb 2 \& [Twitter] \& tweet = @META{author} released {{$MODULE}} {{$VERSION}}: {{$URL}} .Ve .SS "\s-1PAUSEID\s0" .IX Subsection "PAUSEID" You must be using the \f(CW\*(C`UploadToCPAN\*(C'\fR or \f(CW\*(C`FakeRelease\*(C'\fR plugin for this plugin to determine your \s-1PAUSEID.\s0 .SS "\s-1HASHTAGS\s0" .IX Subsection "HASHTAGS" You can use the \f(CW\*(C`hash_tags\*(C'\fR option to append hash tags (or anything, really) to the end of the message generated from \f(CW\*(C`tweet\*(C'\fR. .PP .Vb 2 \& [Twitter] \& hash_tags = #perl #cpan #foo .Ve .SH "AVAILABILITY" .IX Header "AVAILABILITY" The latest version of this module is available from the Comprehensive Perl Archive Network (\s-1CPAN\s0). Visit to find a \s-1CPAN\s0 site near you, or see . .SH "SOURCE" .IX Header "SOURCE" The development version is on github at and may be cloned from .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" You can make new bug reports, and view existing ones, through the web interface at . .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 David Golden .IP "\(bu" 4 Mike Doherty .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2014 by David Golden. .PP This is free software, licensed under: .PP .Vb 1 \& The Apache License, Version 2.0, January 2004 .Ve