Bug #114749 for Dist-Zilla-Plugin-ReadmeFromPod: ReadmeFromPod deletes content from my distribution's main package

Thu May 26 17:27:49 2016 davor [...] stat.ubc.ca - Ticket created

Subject:	ReadmeFromPod deletes content from my distribution's main package
Date:	Thu, 26 May 2016 14:27:39 -0700
To:	bug-Dist-Zilla-Plugin-ReadmeFromPod [...] rt.cpan.org
From:	Davor Cubranic <davor [...] stat.ubc.ca>

Steps to reproduce (Dist::Zilla 6.005, ReadmeFromPod 0.33): 1. check out github.com/cubranic/Statistics-R-IO v0.101 2. run `dzil build` 3. run `git diff`: lib/Statistics/R/IO.pm will have almost all of its code content removed. Only the pod following “__END__” will remain. Remove the entry for ReadmeFromPod from the distribution’s `dist.ini` to see that the problem is caused by this plugin.

Thu May 26 19:12:32 2016 ether [...] cpan.org - Correspondence added

On 2016-05-26 14:27:49, davor@stat.ubc.ca wrote: Show quoted text

> Steps to reproduce (Dist::Zilla 6.005, ReadmeFromPod 0.33): > > 1. check out github.com/cubranic/Statistics-R-IO v0.101 > 2. run `dzil build` > 3. run `git diff`: lib/Statistics/R/IO.pm will have almost all of its > code content removed. Only the pod following “__END__” will remain. > > Remove the entry for ReadmeFromPod from the distribution’s `dist.ini` > to see that the problem is caused by this plugin.

Due to the number of other unresolved issues in this plugin (https://rt.cpan.org/Dist/Display.html?Queue=Dist-Zilla-Plugin-ReadmeFromPod), I would recommend you switch to ReadmeAnyFromPod or Pod2Readme.

Thu May 26 19:12:33 2016 The RT System itself - Status changed from 'new' to 'open'

Thu May 26 19:19:38 2016 KENTNL [...] cpan.org - Correspondence added

On 2016-05-27 09:27:49, davor@stat.ubc.ca wrote:
> Steps to reproduce (Dist::Zilla 6.005, ReadmeFromPod 0.33):
>
> 1. check out github.com/cubranic/Statistics-R-IO v0.101
> 2. run `dzil build`
> 3. run `git diff`: lib/Statistics/R/IO.pm will have almost all of its
> code content removed. Only the pod following “__END__” will remain.
>
> Remove the entry for ReadmeFromPod from the distribution’s `dist.ini`
> to see that the problem is caused by this plugin.

This problem is grossly exacerbated because "README.pod" in your dist is presently a *symlink* to "lib/Statistics/R/IO.pm".

This means regardless of what "Readme" generator you use, your configuration states "replace my code with only the POD version of that code".

ReadmeFromPod has its own problems, but your problem with the symlink must be resolved before you expect anything to work here.

Thu May 26 19:31:12 2016 davor [...] stat.ubc.ca - Correspondence added

Subject:	Re: [rt.cpan.org #114749] ReadmeFromPod deletes content from my distribution's main package
Date:	Thu, 26 May 2016 16:30:59 -0700
To:	bug-Dist-Zilla-Plugin-ReadmeFromPod [...] rt.cpan.org
From:	Davor Cubranic <davor [...] stat.ubc.ca>

Having the README.pod symlink makes the pod from the top-level module (IO.pm) show up on the project’s home page at Github. Note that this doesn’t hurt generating the release, as you can see in the ‘release’ branch on Github: the correct README is in the project root (https://github.com/cubranic/Statistics-R-IO/blob/release/README) and the IO.pm module does contain the full code (https://github.com/cubranic/Statistics-R-IO/blob/release/lib/Statistics/R/IO.pm). It’s just that what’s left behind in my working directory after running `dzil build` is a mangled IO.pm. If you have a better recommendation that will avoid only the latter, while still working for the Github home page and the release generation, I’d be happy to use it. In the meantime, Pod2Readme seems to be able to handle this just fine. Show quoted text

> On May 26, 2016, at 4:19 PM, Kent Fredric via RT <bug-Dist-Zilla-Plugin-ReadmeFromPod@rt.cpan.org> wrote: > > <URL: https://rt.cpan.org/Ticket/Display.html?id=114749 > > > On 2016-05-27 09:27:49, davor@stat.ubc.ca wrote:

>> Steps to reproduce (Dist::Zilla 6.005, ReadmeFromPod 0.33): >> >> 1. check out github.com/cubranic/Statistics-R-IO v0.101 >> 2. run `dzil build` >> 3. run `git diff`: lib/Statistics/R/IO.pm will have almost all of its >> code content removed. Only the pod following “__END__” will remain. >> >> Remove the entry for ReadmeFromPod from the distribution’s `dist.ini` >> to see that the problem is caused by this plugin.

> > > This problem is grossly exacerbated because "README.pod" in your dist is > presently a *symlink* to "lib/Statistics/R/IO.pm". > > This means regardless of what "Readme" generator you use, your configuration > states "replace my code with only the POD version of that code". > > ReadmeFromPod has its own problems, but your problem with the symlink must be > resolved before you expect anything to work here.

Thu May 26 19:44:09 2016 davor [...] stat.ubc.ca - Correspondence added

Subject:	Re: [rt.cpan.org #114749] ReadmeFromPod deletes content from my distribution's main package
Date:	Thu, 26 May 2016 16:43:48 -0700
To:	bug-Dist-Zilla-Plugin-ReadmeFromPod [...] rt.cpan.org
From:	Davor Cubranic <davor [...] stat.ubc.ca>

Thanks for suggestions. I actually came across Pod2Readme earlier today, which got me to file this bug in the first place. (I’ve lived with it for a long time, it was just something to endure on release. :-) Show quoted text

> On May 26, 2016, at 4:12 PM, Karen Etheridge via RT <bug-Dist-Zilla-Plugin-ReadmeFromPod@rt.cpan.org> wrote: > > <URL: https://rt.cpan.org/Ticket/Display.html?id=114749 > > > On 2016-05-26 14:27:49, davor@stat.ubc.ca wrote:

>> Steps to reproduce (Dist::Zilla 6.005, ReadmeFromPod 0.33): >> >> 1. check out github.com/cubranic/Statistics-R-IO v0.101 >> 2. run `dzil build` >> 3. run `git diff`: lib/Statistics/R/IO.pm will have almost all of its >> code content removed. Only the pod following “__END__” will remain. >> >> Remove the entry for ReadmeFromPod from the distribution’s `dist.ini` >> to see that the problem is caused by this plugin.

> > > Due to the number of other unresolved issues in this plugin (https://rt.cpan.org/Dist/Display.html?Queue=Dist-Zilla-Plugin-ReadmeFromPod), I would recommend you switch to ReadmeAnyFromPod or Pod2Readme.

Thu May 26 20:01:00 2016 KENTNL [...] cpan.org - Correspondence added

On 2016-05-27 11:31:12, davor@stat.ubc.ca wrote:
> If you have a better recommendation that will avoid only the latter,
> while still working for the Github home page and the release
> generation, I’d be happy to use it. In the meantime, Pod2Readme seems
> to be able to handle this just fine.

Yeah, here, you'd be looking for a "Don't copy README back to Root" option, but in the lack of said option, this could even be considered to be "desired behaviour" for ReadmeFromPod, it just doesn't expect to be copying back over a symlink.

https://metacpan.org/source/FAYLAND/Dist-Zilla-Plugin-ReadmeFromPod-0.33/lib/Dist/Zilla/Plugin/ReadmeFromPod.pm#L87

https://metacpan.org/source/FAYLAND/Dist-Zilla-Plugin-ReadmeFromPod-0.33/lib/Dist/Zilla/Plugin/ReadmeFromPod.pm#L106-108

ReadmeAnyFromPod ( Key word being "Any" ) is slightly better implemented, and avoids certain other problems ReadmeFromPod exhibits, and also defaults to *not* copying back to Root.

https://metacpan.org/pod/Dist::Zilla::Plugin::ReadmeAnyFromPod#location

https://metacpan.org/source/RTHOMPSON/Dist-Zilla-Plugin-ReadmeAnyFromPod-0.161170/lib/Dist/Zilla/Plugin/ReadmeAnyFromPod.pm#L107

( However, using the latter in conjuction with location = root will bring your sorrows back :]. I had just initially thought generating .pod in the source tree was to be desired behaviour )