3 use warnings FATAL => 'all';
5 use ExtUtils::MakeMaker ();
10 our $VERSION = '0.003000';
13 my $MM_VER = eval $ExtUtils::MakeMaker::VERSION;
16 author manifest_include readme_generator
21 warnings->import(FATAL => 'all');
22 if (!(@MM::ISA == 1 && $MM::ISA[0] eq 'Distar::MM')) {
23 @Distar::MM::ISA = @MM::ISA;
24 @MM::ISA = qw(Distar::MM);
26 goto &Exporter::import;
44 '' => qr{Changes|MANIFEST|README|LICENSE|META\.yml},
45 'maint' => qr{[^.].*},
48 sub manifest_include {
53 sub readme_generator {
54 die "readme_generator unsupported" if @_ && $_[0];
57 sub write_manifest_skip {
59 my @files = @Manifest;
61 while (my ($dir, $spec) = splice(@files, 0, 2)) {
62 my $re = ($dir ? $dir.'/' : '').
63 ((ref($spec) eq 'Regexp')
67 # print ref as well as stringification in case of overload ""
68 : die "spec must be string or regexp, was: ${spec} (${\ref $spec})");
71 my $dist_name = $mm->{DISTNAME};
72 my $include = join '|', map "${_}\$", @parts;
73 my $final = "^(?:\Q$dist_name\E-v?[0-9_.]+/|(?!$include))";
74 open my $skip, '>', 'MANIFEST.SKIP'
75 or die "can't open MANIFEST.SKIP: $!";
76 print $skip "${final}\n";
83 sub _gen_make_section {
89 s/^\t?/\t/mg for @lines;
94 s/\n?\z/\n/ for @lines;
100 my ($class, $args) = @_;
101 my %test = %{$args->{test}||{}};
102 my $tests = $test{TESTS} || 't/*.t';
103 $tests !~ /\b\Q$_\E\b/ and $tests .= " $_"
104 for 'xt/*.t', 'xt/*/*.t';
105 $test{TESTS} = $tests;
106 return $class->SUPER::new({
108 MIN_PERL_VERSION => '5.006',
110 AUTHOR => ($MM_VER >= 6.5702 ? $Distar::Author : join(', ', @$Distar::Author)),
112 (exists $args->{ABSTRACT} ? () : (ABSTRACT_FROM => $args->{VERSION_FROM})),
115 realclean => { FILES => (
116 ($args->{realclean}{FILES}||'')
117 . ' Distar/ MANIFEST.SKIP MANIFEST MANIFEST.bak'
124 `git ls-files --error-unmatch MANIFEST.SKIP 2>&1`;
125 my $maniskip_tracked = !$?;
127 Distar::write_manifest_skip($self)
128 unless $maniskip_tracked;
129 $self->SUPER::flush(@_);
132 sub special_targets {
134 my $targets = $self->SUPER::special_targets(@_);
135 my $phony_targets = join ' ', qw(
150 $targets =~ s/^(\.PHONY *:.*)/$1 $phony_targets/m;
156 my $out = $self->SUPER::init_dist(@_);
158 my $dn = File::Spec->devnull;
159 my $tar = $self->{TAR};
161 my $tarflags = $self->{TARFLAGS};
162 if (my ($flags) = $tarflags =~ /^-?([cvhlLf]+)$/) {
163 if ($flags =~ s/c// && $flags =~ s/f//) {
164 $tarflags = '--format=ustar -c'.$flags.'f';
166 for my $options ('--owner=0 --group=0', '--uid=0 --gid=0') {
167 my $try = `$tar -c $options "$me" 2>$dn`;
169 $tarflags = "$options $tarflags";
177 $self->{TARFLAGS} = $tarflags;
186 # default setup for Distar involves checking it out as a subdirectory at
187 # the top of the dist. Without NORECURS, EUMM would try to include
188 # Distar's Makefile.PL. Prevent EUMM from looking inside.
190 if $path eq 'Distar';
192 $self->SUPER::libscan(@_);
197 my $out = $self->SUPER::tarfile_target(@_);
198 my $verify = _gen_make_section([
199 '$(ABSPERLRUN) $(HELPERS)/verify-tarball $(DISTVNAME).tar $(DISTVNAME)/MANIFEST --tar="$(TAR)"',
201 $out =~ s{(\$\(TAR\).*\n)}{$1$verify};
208 my $distar_lib = File::Basename::dirname(__FILE__);
209 my $helpers = File::Spec->catdir($distar_lib, 'Distar', 'helpers');
211 my $licenses = $self->{LICENSE} || $self->{META_ADD}{license} || $self->{META_MERGE}{license};
212 my $authors = $self->{AUTHOR};
213 $_ = ref $_ ? $_ : [$_ || ()]
214 for $licenses, $authors;
217 DISTAR_LIB => $self->quote_literal($distar_lib),
218 HELPERS => $self->quote_literal($helpers),
219 REMAKE => join(' ', '$(PERLRUN)', '-I$(DISTAR_LIB)', '-MDistar', 'Makefile.PL', map { $self->quote_literal($_) } @ARGV),
220 BRANCH => $self->{BRANCH} ||= 'master',
221 CHANGELOG => $self->{CHANGELOG} ||= 'Changes',
222 DEV_NULL_STDOUT => ($self->{DEV_NULL} ? '>'.File::Spec->devnull : ''),
223 DISTTEST_MAKEFILE_PARAMS => '',
224 AUTHORS => $self->quote_literal(join(', ', @$authors)),
225 LICENSES => join(' ', map $self->quote_literal($_), @$licenses),
226 GET_CHANGELOG => '$(ABSPERLRUN) $(HELPERS)/get-changelog $(VERSION) $(CHANGELOG)',
228 -e File::Spec->catdir($distar_lib, File::Spec->updir, '.git')
229 ? 'git -C $(DISTAR_LIB) pull'
230 : '$(ECHO) "Distar code is not in a git repo, unable to update!"'
234 my $dist_test = $self->SUPER::dist_test(@_);
235 $dist_test =~ s/(\bMakefile\.PL\b)/$1 \$(DISTTEST_MAKEFILE_PARAMS)/;
238 if (open my $fh, '<', 'maint/Makefile.include') {
239 $include = do { local $/; <$fh> };
240 $include =~ s/\n?\z/\n/;
246 'preflight: check-version check-manifest check-cpan-upload' => [
247 '$(ABSPERLRUN) $(HELPERS)/preflight $(VERSION) --changelog=$(CHANGELOG) --branch=$(BRANCH)',
249 'check-version:' => [
250 '$(ABSPERLRUN) $(HELPERS)/check-version $(VERSION) $(TO_INST_PM) $(EXE_FILES)',
252 'check-manifest:' => [
253 '$(ABSPERLRUN) $(HELPERS)/check-manifest',
255 'check-cpan-upload:' => [
256 '$(NOECHO) cpan-upload -h $(DEV_NULL_STDOUT)',
259 '$(MAKE) disttest RELEASE_TESTING=1 DISTTEST_MAKEFILE_PARAMS="PREREQ_FATAL=1" PASTHRU="$(PASTHRU) TEST_FILES=\"$(TEST_FILES)\""',
260 '$(NOECHO) $(TEST_F) $(DISTVNAME)/LICENSE || $(ECHO) "Failed to generate $(DISTVNAME)/LICENSE!" >&2',
261 '$(NOECHO) $(TEST_F) $(DISTVNAME)/LICENSE',
263 'release: preflight' => [
264 '$(MAKE) releasetest',
265 '$(GET_CHANGELOG) -p"Release commit for $(VERSION)" | git commit -a -F -',
266 '$(GET_CHANGELOG) -p"release v$(VERSION)" | git tag -a -F - "v$(VERSION)"',
267 '$(RM_RF) $(DISTVNAME)',
268 '$(MAKE) $(DISTVNAME).tar$(SUFFIX)',
269 '$(NOECHO) $(MAKE) pushrelease FAKE_RELEASE=$(FAKE_RELEASE)',
271 'pushrelease ::' => [
274 'pushrelease$(FAKE_RELEASE) ::' => [
275 'cpan-upload $(DISTVNAME).tar$(SUFFIX)',
276 'git push origin v$(VERSION) HEAD',
278 'distdir: readmefile licensefile',
279 'readmefile: create_distdir' => [
280 '$(NOECHO) $(TEST_F) $(DISTVNAME)/README || $(MAKE) $(DISTVNAME)/README',
282 '$(DISTVNAME)/README: $(VERSION_FROM)' => [
283 '$(NOECHO) $(MKPATH) $(DISTVNAME)',
284 'pod2text $(VERSION_FROM) >$(DISTVNAME)/README',
285 '$(NOECHO) $(ABSPERLRUN) $(HELPERS)/add-to-manifest -d $(DISTVNAME) README',
287 'distsignature: readmefile licensefile',
288 'licensefile: create_distdir' => [
289 '$(NOECHO) $(TEST_F) $(DISTVNAME)/LICENSE || $(MAKE) $(DISTVNAME)/LICENSE || $(TRUE)',
291 '$(DISTVNAME)/LICENSE: Makefile.PL' => [
292 '$(NOECHO) $(MKPATH) $(DISTVNAME)',
293 '$(ABSPERLRUN) $(HELPERS)/generate-license -o $(DISTVNAME)/LICENSE $(AUTHORS) $(LICENSES)',
294 '$(NOECHO) $(ABSPERLRUN) $(HELPERS)/add-to-manifest -d $(DISTVNAME) LICENSE',
296 'disttest: distmanicheck',
297 'distmanicheck: create_distdir' => [
298 $self->cd('$(DISTVNAME)',
299 '$(ABSPERLRUN) "-MExtUtils::Manifest=manicheck" -e "exit manicheck"',
303 '$(ABSPERLRUN) $(HELPERS)/add-changelog-heading --git $(VERSION) $(CHANGELOG)',
307 '$(RM_F) $(FIRST_MAKEFILE)',
313 grep { $include !~ /^bump$_(?: +\w+)*:/m } ('', 'minor', 'major');
317 '$(ABSPERLRUN) $(HELPERS)/bump-version --git $(VERSION) '.($_ || '$(V)'),
318 '$(RM_F) $(FIRST_MAKEFILE)',
325 "\n\n# --- Distar section:\n\n",
326 (map "$_ = $vars{$_}\n", sort keys %vars),
328 _gen_make_section(@out),
331 "# --- Makefile.include:\n",
346 Distar - Additions to ExtUtils::MakeMaker for dist authors
352 use ExtUtils::MakeMaker;
353 (do './maint/Makefile.PL.include' or die $@) unless -f 'META.yml';
357 F<maint/Makefile.PL.include>:
359 BEGIN { -e 'Distar' or system qw(git clone https://github.com/p5sagit/Distar.git) }
360 use lib 'Distar/lib';
363 author 'A. U. Thor <author@cpan.org>';
365 manifest_include t => 'test-helper.pl';
366 manifest_include corpus => '.txt';
371 $ make bump # bump version
372 $ make bump V=2.000000 # bump to specific version
373 $ make bumpminor # bump minor version component
374 $ make bumpmajor # bump major version component
375 $ make nextrelease # add version heading to Changes file
376 $ make releasetest # build dist and test (with xt/ and RELEASE_TESTING=1)
377 $ make preflight # check that repo and file state is release ready
378 $ make release # check releasetest and preflight, commits and tags,
379 # builds and uploads to CPAN, and pushes commits and
381 $ make release FAKE_RELEASE=1
382 # builds a release INCLUDING committing and tagging,
383 # but does not upload to cpan or push anything to git
387 L<ExtUtils::MakeMaker> works well enough as development tool for
388 builting and testing, but using it to release is annoying and error prone.
389 Distar adds just enough to L<ExtUtils::MakeMaker> for it to be a usable dist
390 author tool. This includes extra commands for releasing and safety checks, and
391 automatic generation of some files. It doesn't require any non-core modules and
392 is compatible with old versions of perl.
396 =head2 author( $author )
398 Set the author to include in generated META files. Can be a single entry, or
401 =head2 manifest_include( $dir, $pattern )
403 Add a pattern to include files in the MANIFEST file, and thus in the generated
406 The pattern can be either a regex, or a path suffix. It will be applied to the
407 full path past the directory specified.
409 The default files that are always included are: F<.pm> and F<.pod> files in
410 F<lib>, F<.t> files in F<t> and F<xt>, F<.pm> files in F<t/lib> and F<xt/lib>,
411 F<Changes>, F<MANIFEST>, F<README>, F<LICENSE>, F<META.yml>, and F<.PL> files in
412 the dist root, and all files in F<maint>.
414 =head1 AUTOGENERATED FILES
418 =item F<MANIFEST.SKIP>
420 The F<MANIFEST.SKIP> will be automatically generated to exclude any files not
421 explicitly allowed via C<manifest_include> or the included defaults. It will be
422 created (or updated) at C<perl Makefile.PL> time.
426 The F<README> file will be generated at dist generation time, inside the built
427 dist. It will be generated using C<pod2text> on the main module.
429 If a F<README> file exists in the repo, it will be used directly instead of
434 =head1 MAKE COMMMANDS
438 test will be adjusted to include F<xt/> tests by default. This will only apply
439 for authors, not users installing from CPAN.
443 Releases the dist. Before releasing, checks will be done on the dist using the
444 C<preflight> and C<releasetest> commands.
446 Releasing will generate a dist tarball and upload it to CPAN using cpan-upload.
447 It will also create a git tag for the release, and push the tag and branch.
451 If release is run with FAKE_RELEASE=1 set, it will skip uploading to CPAN and
452 pushing to git. A release commit will still be created and tagged locally.
456 Performs a number of checks on the files and repository, ensuring it is in a
457 sane state to do a release. The checks are:
461 =item * All version numbers match
463 =item * The F<MANIFEST> file is up to date
465 =item * The branch is correct
467 =item * There is no existing tag for the version
469 =item * There are no unmerged upstream changes
471 =item * There are no outstanding local changes
473 =item * There is an appropriate staged Changes heading
475 =item * cpan-upload is available
481 Test the dist preparing for a release. This generates a dist dir and runs the
482 tests from inside it. This ensures all appropriate files are included inside
483 the dist. C<RELEASE_TESTING> will be set in the environment.
487 Adds an appropriate changelog heading for the release, and prompts to stage the
492 Bumps the version number. This will try to preserve the length and format of
493 the version number. The least significant digit will be incremented. Versions
494 with underscores will preserve the underscore in the same position.
496 Optionally accepts a C<V> option to set the version to a specific value.
498 The version changes will automatically be committed. Unstaged modifications to
499 the files will be left untouched.
503 The V option will be passed along to the version bumping script. It can accept
504 a space separated list of options, including an explicit version number.
512 Updates version numbers even if they do not match the current expected version
517 Attempts to convert the updated version to a stable version, removing any
522 Attempts to convert the updated version to an alpha version, adding an
523 underscore in an appropriate place.
529 Like bump, but increments the minor segment of the version. This will treat
530 numeric versions as x.yyyzzz format, incrementing the yyy segment.
534 Like bumpminor, but bumping the major segment.
538 Updates Distar and re-runs C<perl Makefile.PL>
542 IRC: #web-simple on irc.perl.org
544 Git repository: L<git://git.shadowcat.co.uk/p5sagit/Distar>
546 Git browser: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit/Distar.git;a=summary>
550 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
554 haarg - Graham Knop (cpan:HAARG) <haarg@cpan.org>
556 ether - Karen Etheridge (cpan:ETHER) <ether@cpan.org>
558 frew - Arthur Axel "fREW" Schmidt (cpan:FREW) <frioux@gmail.com>
560 Mithaldu - Christian Walde (cpan:MITHALDU) <walde.christian@googlemail.com>
564 Copyright (c) 2011-2015 the Distar L</AUTHOR> and L</CONTRIBUTORS>
569 This library is free software and may be distributed under the same terms
570 as perl itself. See L<http://dev.perl.org/licenses/>.