| 1 | package Dist::Zilla::Role::ArchiveBuilder 6.040; | ||
| 2 | # ABSTRACT: something that builds archives | ||
| 3 | |||
| 4 | 2 | ▶ | use Moose::Role; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 5 | 2 | with 'Dist::Zilla::Role::Plugin'; | |
| 6 | |||
| 7 | 2 | ▶ | use Dist::Zilla::Pragmas; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 8 | |||
| 9 | 2 | requires 'build_archive'; | |
| 10 | |||
| 11 | #pod =head1 DESCRIPTION | ||
| 12 | #pod | ||
| 13 | #pod Plugins implementing this role have their C<build_archive> method called | ||
| 14 | #pod when it is time to build the archive. | ||
| 15 | #pod | ||
| 16 | #pod =method build_archive | ||
| 17 | #pod | ||
| 18 | #pod This method takes three arguments, and returns a L<Path::Tiny> instance | ||
| 19 | #pod containing the path to the archive. | ||
| 20 | #pod | ||
| 21 | #pod =over 4 | ||
| 22 | #pod | ||
| 23 | #pod =item archive_basename | ||
| 24 | #pod | ||
| 25 | #pod This is the name of the archive (including C<-TRIAL> if appropriate) without | ||
| 26 | #pod the format extension (that is the C<.tar.gz> part). The plugin implementing | ||
| 27 | #pod this role should add the appropriate full path including extension as the | ||
| 28 | #pod returned L<Path::Tiny> instance. Not including the extension allows the | ||
| 29 | #pod plugin to choose its own format. | ||
| 30 | #pod | ||
| 31 | #pod =item built_in | ||
| 32 | #pod | ||
| 33 | #pod This is a L<Path::Tiny> where the distribution has been built. | ||
| 34 | #pod | ||
| 35 | #pod =item dist_basename | ||
| 36 | #pod | ||
| 37 | #pod This method will return the dist's basename (e.g. C<Dist-Name-1.01> as a | ||
| 38 | #pod L<Path::Tiny>. The basename is used as the top-level directory in the | ||
| 39 | #pod tarball. It does not include C<-TRIAL>, even if building a trial dist. | ||
| 40 | #pod | ||
| 41 | #pod =back | ||
| 42 | #pod | ||
| 43 | #pod =cut | ||
| 44 | |||
| 45 | 2 | ▶ | no Moose::Role; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 46 | 2 | 1; | |
| 47 | |||
| 48 | __END__ | ||