Bug #85019 for Dist-Zilla-PluginBundle-Apocalyptic: GitHub README

Fri May 03 05:36:43 2013 lxp [...] cpan.org - Ticket created

Subject:

GitHub README

In the "Future Plans" section of your POD for this bundle, you mention that you'd like to automatically update the README file for GitHub's main page: Show quoted text

> GitHub needs a README - can we extract it and upload it on release? > ( the current Dist::Zilla::Plugin::Readme doesn't extract the entire > POD... )

In case you're still interested, I achieve this using the following dist.ini definitions: ; Add a README file to the build, generated from the finalised POD for ; the main module. [ReadmeAnyFromPod] ; Also generate a README POD file for the repository root. (This does ; not form part of the final build.) [ReadmeAnyFromPod / PodRoot] ; Don't allow a release to occur while there are dirty files (other ; than those that may have new version information written as part of ; the build process). [Git::Check] allow_dirty = Changes allow_dirty = dist.ini allow_dirty = README.pod ; Commit changes to the files modified after a release. ; (Must be defined after [NextRelease].) [Git::Commit] allow_dirty = Changes allow_dirty = dist.ini allow_dirty = README.pod

Fri Oct 24 03:16:06 2014 APOCAL [...] cpan.org - Correspondence added

Hello, Thanks very much for this suggestion! I've incorporated it into my workflow and after a bit more testing I'll release the next version that automatically generates README.pod in the rootdir :) On Fri May 03 05:36:43 2013, LXP wrote: Show quoted text

> In the "Future Plans" section of your POD for this bundle, you mention > that you'd like to automatically update the README file for GitHub's > main page: >

> > GitHub needs a README - can we extract it and upload it on release? > > ( the current Dist::Zilla::Plugin::Readme doesn't extract the entire > > POD... )

> > In case you're still interested, I achieve this using the following > dist.ini definitions: > > ; Add a README file to the build, generated from the finalised POD for > ; the main module. > [ReadmeAnyFromPod] > > ; Also generate a README POD file for the repository root. (This does > ; not form part of the final build.) > [ReadmeAnyFromPod / PodRoot] > > ; Don't allow a release to occur while there are dirty files (other > ; than those that may have new version information written as part of > ; the build process). > [Git::Check] > allow_dirty = Changes > allow_dirty = dist.ini > allow_dirty = README.pod > > ; Commit changes to the files modified after a release. > ; (Must be defined after [NextRelease].) > [Git::Commit] > allow_dirty = Changes > allow_dirty = dist.ini > allow_dirty = README.pod

-- ~Apocalypse

Fri Oct 24 03:16:07 2014 The RT System itself - Status changed from 'new' to 'open'

Fri Oct 24 16:40:18 2014 ether [...] cpan.org - Correspondence added

On 2014-10-24 00:16:06, APOCAL wrote: Show quoted text

> Hello, > > Thanks very much for this suggestion! I've incorporated it into my > workflow and after a bit more testing I'll release the next version > that automatically generates README.pod in the rootdir :)

BE CAREFUL!!!!!! Do not ship README.pod in the uploaded distribution, or it will be installed in PERL5LIB as any other module, and also have a manpage generated for it of the form Foo::Bar::README (assuming the distribution name Foo-Bar-Baz). See Dist::Zilla::PluginBundle::Author::ETHER for how to avoid this -- I generate a README.pod for github and commit it after release, but it never enters the uploaded dist dir.

Sat Oct 25 16:28:48 2014 APOCAL [...] cpan.org - Correspondence added

Hello, Thanks for the pointer! I've double-checked my configs and verified that the shipped tarball doesn't include README.pod :) Maybe an opportunity for a new dzil plugin to sanitycheck that? Thanks again and 0.004 is now on the way to CPAN! On Fri Oct 24 16:40:18 2014, ETHER wrote: Show quoted text

> On 2014-10-24 00:16:06, APOCAL wrote:

> > Hello, > > > > Thanks very much for this suggestion! I've incorporated it into my > > workflow and after a bit more testing I'll release the next version > > that automatically generates README.pod in the rootdir :)

> > BE CAREFUL!!!!!! Do not ship README.pod in the uploaded distribution, > or it will be installed in PERL5LIB as any other module, and also have > a manpage generated for it of the form Foo::Bar::README (assuming the > distribution name Foo-Bar-Baz). > > See Dist::Zilla::PluginBundle::Author::ETHER for how to avoid this -- > I generate a README.pod for github and commit it after release, but it > never enters the uploaded dist dir.

-- ~Apocalypse

Sat Oct 25 16:28:50 2014 APOCAL [...] cpan.org - Status changed from 'open' to 'resolved'