travis build badges, POD, dist::zilla and pod::weaver
I've taken the plunge with the excellent Dist::Zilla recently for authoring my Perl distributions. Since picking up the maintainer role of S::R::D, D::Z fit my needs perfectly: speed up distribution and alleviate all the repetitive parts of the process.
I recently started work on Perl bindings to the
Browsermob Proxy REST API called, unimaginatively,
Browsermob::Proxy. As usual, we want it to run its tests on
travis, and there's the lovely [TravisYML] plugin for that:
# dist.ini
[TravisYML]
[GatherDir]
include_dotfiles = 1
[PruneCruft]
except = \.travis.yml
[PodWeaver]
[ReadmeAnyFromPod]
type = markdown
filename = README.md
location = root
and we also want to use Pod::Weaver for more of that DRY
goodness. Since we're writing all the documentation in the main module
anyway, [ReadmeAnyFromPod] generates a markdown readme for us that
Github likes. The last bit is getting the Travis build status badge
into that readme. Surprisingly, Travis even have a suggested form for
POD badges:
=for HTML <a href="https://travis-ci.org/gempesaw/Browsermob...
But unfortunately that won't work in our case, since we're outputting
to markdown. Via trial and error, I found that using the markdown form
of the build badge in a =for markdown POD section works with
[ReadmeAnyFromPod] with type = markdown:
=for markdown [