byterock

Knocking off another Section here at the Dist-Pen today.

The last few posts I was dealing with the trials and tribulation of the [Availability] section plug-in, today I am going to look at another section plug-in [Bugs].

As the name implies add a 'Bug' blurb to your POD. Like the plug-in from my last posts this one is closely entwined with Dist::Zilla and we are luck this time as the POD for this one is quite extensive and does a good job on explaining how to use it. Hopefully, I will not find another bug.

The gem I found in the POD was you can use this Dist::Zilla plug-in [MetaResources] to add name key-value pairs into the 'repository' key of the meta data. At the present time I have all that the key-values I think I need because I use the [GithubMeta] plug-in to gather that data.

To see this in action, I did try an install of the Plug-in but it seems it comes packaged with Pod::Weaver so all I really needed to to was add it to my 'weaver.ini';

[Availability]

++[Bugs]

[Legal]

then a dzil build and clean with this result;

=head1 BUGS


Please report any bugs or feature requests on the bugtracker website

L<http://rt.cpan.org/Public/Dist/Display.html?Name=Database-Accessor> or by

email to L<bug-database-accessor at

rt.cpan.org|mailto:bug-database-accessor at rt.cpan.org>.

When submitting a bug or request, please include a test-file or a

patch to an existing test-file that illustrates the bug or desired

feature.

Ok I guess but I do not want to use rt.cpan as my bug tracker I would like to use git-hub.
Looking at the JSON meta;

      "bugtracker" : {

         "mailto" : "bug-database-accessor at rt.cpan.org",

         "web" : "http://rt.cpan.org/Public/Dist/Display.html?Name=Database-Accessor"

      },

I will have to change the above to get what I want. In my case if I use the [MetaResources] plug-in to change that around say like this

[MetaResources]

bugtracker.web = https://github.com/byterock/database-accessor/issues

bugtracker.mailto = scolesj@somthing.com

in my 'dist.ini' I would get this sort of error;

Duplication of element resources.bugtracker.mailto 

when I tried to build. The reason for this is [MetaResources] and [Bugtracker] are trying to declare the same key so what I have to do is drop [MetaResources] and change what [Bugtracker] is outputting to what I had in the earlier post.

...

[Bugtracker]

++web = https://github.com/byterock/%l/issues

++ mailto = test@test.com

…

and after the clean and build I get

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website

L<https://github.com/byterock/database-accessor/issues> or by email to

L<test@test.com|mailto:test@test.com>.

…

and it gives me exactly what I want. Notice how I am using the %l here which is the all lower-case version of my module name. There are a few other options '%s' the default value and %U all uppercase.

This plug-in like most section plug-in supports the 'header' attribute so you can change the name of the section if you like.

So no bugs today and I did learn about the very useful Dist::Zill [MetaResources] plug-in, that one can use to add keys and key-value pairs to your meta files.

Yes I know Motra is a lepidoptera not a coleoptera but at least it is an Insecta