Skip to content

Commit

Permalink
v0.132973
Browse files Browse the repository at this point in the history
    - now using FileGatherer, FileMunger and AfterBuild phases rather than
      InstallerTool
  • Loading branch information
DarwinAwardWinner committed Oct 24, 2013
1 parent 395dc8c commit e9d5f37
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 4 deletions.
2 changes: 2 additions & 0 deletions Changes
@@ -1,6 +1,8 @@
Revision history for Dist-Zilla-Plugin-ReadmeAnyFromPod

{{$NEXT}}

0.132973 2013-10-23 17:15:29 America/Los_Angeles
- now using FileGatherer, FileMunger and AfterBuild phases rather than
InstallerTool

Expand Down
28 changes: 24 additions & 4 deletions README.pod
Expand Up @@ -6,7 +6,7 @@ Dist::Zilla::Plugin::ReadmeAnyFromPod - Automatically convert POD to a README in

=head1 VERSION

version 0.132962
version 0.132973

=head1 SYNOPSIS

Expand Down Expand Up @@ -41,6 +41,14 @@ attributes from it. The format is "Readme[TYPE]In[LOCATION]". The
words "Readme" and "In" are optional, and the whole name is
case-insensitive. The SYNOPSIS section above gives one example.

When run with C<location = dist>, this plugin runs in the C<FileMunger> phase
to create the new file. If it runs before another C<FileMunger> plugin does,
that happens to modify the input pod (like, say,
L<C<[PodWeaver]>|Dist::Zilla::Plugin::PodWeaver>), the README file contents
will be recalculated, along with a warning that you should modify your
F<dist.ini> by referencing C<[ReadmeAnyFromPod]> lower down in the file (the
build still works, but is less efficient).

=head1 ATTRIBUTES

=head2 type
Expand Down Expand Up @@ -77,15 +85,27 @@ built dist.

=head1 METHODS

=head2 gather_files

We create the file early, so other plugins that need to have the full list of
files are aware of what we will be generating.

=head2 prune_files

Files with C<location = root> must also be pruned, so that they don't
sneak into the I<next> build by virtue of already existing in the root
dir.
dir. (The alternative is that the user doesn't add them to the build in the
first place, with an option to their C<GatherDir> plugin.)

=head2 munge_files

=head2 munge_file

Edits the content into the requested README file in the dist.

=head2 setup_installer
=head2 after_build

Adds the requested README file to the dist.
Create the requested README file in the root.

=head2 get_readme_content

Expand Down

0 comments on commit e9d5f37

Please sign in to comment.