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;
43 '' => qr{Changes|MANIFEST|README|LICENSE|META\.yml},
44 'maint' => qr{[^.].*},
47 sub manifest_include {
51 sub readme_generator {
52 die "readme_generator unsupported" if @_ && $_[0];
55 sub write_manifest_skip {
57 my @files = @Manifest;
59 while (my ($dir, $spec) = splice(@files, 0, 2)) {
60 my $re = ($dir ? $dir.'/' : '').
61 ((ref($spec) eq 'Regexp')
65 # print ref as well as stringification in case of overload ""
66 : die "spec must be string or regexp, was: ${spec} (${\ref $spec})");
69 my $dist_name = $mm->{DISTNAME};
70 my $include = join '|', map "${_}\$", @parts;
71 my $final = "^(?:\Q$dist_name\E-v?[0-9_.]+/|(?!$include))";
72 open my $skip, '>', 'MANIFEST.SKIP'
73 or die "can't open MANIFEST.SKIP: $!";
74 print $skip "${final}\n";
82 my ($class, $args) = @_;
83 my %test = %{$args->{test}||{}};
84 my $tests = $test{TESTS} || 't/*.t';
85 $tests !~ /\b\Q$_\E\b/ and $tests .= " $_"
86 for 'xt/*.t', 'xt/*/*.t';
87 $test{TESTS} = $tests;
88 return $class->SUPER::new({
90 MIN_PERL_VERSION => '5.006',
92 AUTHOR => ($MM_VER >= 6.5702 ? $Distar::Author : join(', ', @$Distar::Author)),
94 (exists $args->{ABSTRACT} ? () : (ABSTRACT_FROM => $args->{VERSION_FROM})),
97 realclean => { FILES => (
98 ($args->{realclean}{FILES}||'')
99 . ' Distar/ MANIFEST.SKIP MANIFEST MANIFEST.bak'
106 `git ls-files --error-unmatch MANIFEST.SKIP 2>&1`;
107 my $maniskip_tracked = !$?;
109 Distar::write_manifest_skip($self)
110 unless $maniskip_tracked;
111 $self->SUPER::flush(@_);
114 sub special_targets {
116 my $targets = $self->SUPER::special_targets(@_);
117 my $phony_targets = join ' ', qw(
132 $targets =~ s/^(\.PHONY *:.*)/$1 $phony_targets/m;
138 my $out = $self->SUPER::init_dist(@_);
140 my $dn = File::Spec->devnull;
141 my $tar = $self->{TAR};
143 my $tarflags = $self->{TARFLAGS};
144 if (my ($flags) = $tarflags =~ /^-?([cvhlLf]+)$/) {
145 if ($flags =~ s/c// && $flags =~ s/f//) {
146 $tarflags = '--format=ustar -c'.$flags.'f';
148 for my $options ('--owner=0 --group=0', '--uid=0 --gid=0') {
149 my $try = `$tar -c $options "$me" 2>$dn`;
151 $tarflags = "$options $tarflags";
159 $self->{TARFLAGS} = $tarflags;
168 # default setup for Distar involves checking it out as a subdirectory at
169 # the top of the dist. Without NORECURS, EUMM would try to include
170 # Distar's Makefile.PL. Prevent EUMM from looking inside.
172 if $path eq 'Distar';
174 $self->SUPER::libscan(@_);
179 my $out = $self->SUPER::tarfile_target(@_);
180 my $verify = <<'END_FRAG';
181 $(ABSPERLRUN) $(HELPERS)/verify-tarball $(DISTVNAME).tar $(DISTVNAME)/MANIFEST --tar="$(TAR)"
183 $out =~ s{(\$\(TAR\).*\n)}{$1$verify};
190 my $distar_lib = File::Basename::dirname(__FILE__);
191 my $helpers = File::Spec->catdir($distar_lib, 'Distar', 'helpers');
193 my $licenses = $self->{LICENSE} || $self->{META_ADD}{license} || $self->{META_MERGE}{license};
194 my $authors = $self->{AUTHOR};
195 $_ = ref $_ ? $_ : [$_ || ()]
196 for $licenses, $authors;
199 DISTAR_LIB => $self->quote_literal($distar_lib),
200 HELPERS => $self->quote_literal($helpers),
201 REMAKE => join(' ', '$(PERLRUN)', '-I$(DISTAR_LIB)', '-MDistar', 'Makefile.PL', map { $self->quote_literal($_) } @ARGV),
202 BRANCH => $self->{BRANCH} ||= 'master',
203 CHANGELOG => $self->{CHANGELOG} ||= 'Changes',
204 DEV_NULL_STDOUT => ($self->{DEV_NULL} ? '>'.File::Spec->devnull : ''),
205 DISTTEST_MAKEFILE_PARAMS => '',
206 AUTHORS => $self->quote_literal(join(', ', @$authors)),
207 LICENSES => join(' ', map $self->quote_literal($_), @$licenses),
208 GET_CHANGELOG => '$(ABSPERLRUN) $(HELPERS)/get-changelog $(VERSION) $(CHANGELOG)',
210 -e File::Spec->catdir($distar_lib, File::Spec->updir, '.git')
211 ? 'git -C $(DISTAR_LIB) pull'
212 : '$(ECHO) "Distar code is not in a git repo, unable to update!"'
216 my $dist_test = $self->SUPER::dist_test(@_);
217 $dist_test =~ s/(\bMakefile\.PL\b)/$1 \$(DISTTEST_MAKEFILE_PARAMS)/;
220 if (open my $fh, '<', 'maint/Makefile.include') {
221 $include = do { local $/; <$fh> };
222 $include =~ s/\n?\z/\n/;
228 preflight: check-version check-manifest check-cpan-upload
229 $(ABSPERLRUN) $(HELPERS)/preflight $(VERSION) --changelog=$(CHANGELOG) --branch=$(BRANCH)
231 $(ABSPERLRUN) $(HELPERS)/check-version $(VERSION) $(TO_INST_PM) $(EXE_FILES)
233 $(ABSPERLRUN) $(HELPERS)/check-manifest
235 $(NOECHO) cpan-upload -h $(DEV_NULL_STDOUT)
237 $(MAKE) disttest RELEASE_TESTING=1 DISTTEST_MAKEFILE_PARAMS="PREREQ_FATAL=1" PASTHRU="$(PASTHRU) TEST_FILES=\"$(TEST_FILES)\""
238 $(NOECHO) $(TEST_F) $(DISTVNAME)/LICENSE || $(ECHO) "Failed to generate $(DISTVNAME)/LICENSE!" >&2
239 $(NOECHO) $(TEST_F) $(DISTVNAME)/LICENSE
242 $(GET_CHANGELOG) -p"Release commit for $(VERSION)" | git commit -a -F -
243 $(GET_CHANGELOG) -p"release v$(VERSION)" | git tag -a -F - "v$(VERSION)"
244 $(RM_RF) $(DISTVNAME)
245 $(MAKE) $(DISTVNAME).tar$(SUFFIX)
246 $(NOECHO) $(MAKE) pushrelease FAKE_RELEASE=$(FAKE_RELEASE)
249 pushrelease$(FAKE_RELEASE) ::
250 cpan-upload $(DISTVNAME).tar$(SUFFIX)
251 git push origin v$(VERSION) HEAD
252 distdir: readmefile licensefile
253 readmefile: create_distdir
254 $(NOECHO) $(TEST_F) $(DISTVNAME)/README || $(MAKE) $(DISTVNAME)/README
255 $(DISTVNAME)/README: $(VERSION_FROM)
256 $(NOECHO) $(MKPATH) $(DISTVNAME)
257 pod2text $(VERSION_FROM) >$(DISTVNAME)/README
258 $(NOECHO) $(ABSPERLRUN) $(HELPERS)/add-to-manifest -d $(DISTVNAME) README
259 distsignature: readmefile licensefile
260 licensefile: create_distdir
261 $(NOECHO) $(TEST_F) $(DISTVNAME)/LICENSE || $(MAKE) $(DISTVNAME)/LICENSE || $(TRUE)
262 $(DISTVNAME)/LICENSE: Makefile.PL
263 $(NOECHO) $(MKPATH) $(DISTVNAME)
264 $(ABSPERLRUN) $(HELPERS)/generate-license -o $(DISTVNAME)/LICENSE $(AUTHORS) $(LICENSES)
265 $(NOECHO) $(ABSPERLRUN) $(HELPERS)/add-to-manifest -d $(DISTVNAME) LICENSE
266 disttest: distmanicheck
267 distmanicheck: create_distdir
268 cd $(DISTVNAME) && $(ABSPERLRUN) "-MExtUtils::Manifest=manicheck" -e "exit manicheck"
270 $(ABSPERLRUN) $(HELPERS)/add-changelog-heading --git $(VERSION) $(CHANGELOG)
273 $(RM_F) $(FIRST_MAKEFILE)
277 grep { $include !~ /^bump$_(?: +\w+)*:/m } ('', 'minor', 'major');
279 for my $target (@bump_targets) {
280 push @out, sprintf <<'END', "bump$target", ($target || '$(V)');
282 $(ABSPERLRUN) $(HELPERS)/bump-version --git $(VERSION) %s
283 $(RM_F) $(FIRST_MAKEFILE)
290 "\n\n# --- Distar section:\n\n",
291 (map "$_ = $vars{$_}\n", sort keys %vars),
296 "# --- Makefile.include:\n",
311 Distar - Additions to ExtUtils::MakeMaker for dist authors
317 use ExtUtils::MakeMaker;
318 (do './maint/Makefile.PL.include' or die $@) unless -f 'META.yml';
322 F<maint/Makefile.PL.include>:
324 BEGIN { -e 'Distar' or system("git clone git://git.shadowcat.co.uk/p5sagit/Distar.git") }
325 use lib 'Distar/lib';
328 author 'A. U. Thor <author@cpan.org>';
330 manifest_include t => 'test-helper.pl';
331 manifest_include corpus => '.txt';
336 $ make bump # bump version
337 $ make bump V=2.000000 # bump to specific version
338 $ make bumpminor # bump minor version component
339 $ make bumpmajor # bump major version component
340 $ make nextrelease # add version heading to Changes file
341 $ make releasetest # build dist and test (with xt/ and RELEASE_TESTING=1)
342 $ make preflight # check that repo and file state is release ready
343 $ make release # check releasetest and preflight, commits and tags,
344 # builds and uploads to CPAN, and pushes commits and
346 $ make release FAKE_RELEASE=1
347 # builds a release INCLUDING committing and tagging,
348 # but does not upload to cpan or push anything to git
352 L<ExtUtils::MakeMaker> works well enough as development tool for
353 builting and testing, but using it to release is annoying and error prone.
354 Distar adds just enough to L<ExtUtils::MakeMaker> for it to be a usable dist
355 author tool. This includes extra commands for releasing and safety checks, and
356 automatic generation of some files. It doesn't require any non-core modules and
357 is compatible with old versions of perl.
361 =head2 author( $author )
363 Set the author to include in generated META files. Can be a single entry, or
366 =head2 manifest_include( $dir, $pattern )
368 Add a pattern to include files in the MANIFEST file, and thus in the generated
371 The pattern can be either a regex, or a path suffix. It will be applied to the
372 full path past the directory specified.
374 The default files that are always included are: F<.pm> and F<.pod> files in
375 F<lib>, F<.t> files in F<t> and F<xt>, F<.pm> files in F<t/lib> and F<xt/lib>,
376 F<Changes>, F<MANIFEST>, F<README>, F<LICENSE>, F<META.yml>, and F<.PL> files in
377 the dist root, and all files in F<maint>.
379 =head1 AUTOGENERATED FILES
383 =item F<MANIFEST.SKIP>
385 The F<MANIFEST.SKIP> will be automatically generated to exclude any files not
386 explicitly allowed via C<manifest_include> or the included defaults. It will be
387 created (or updated) at C<perl Makefile.PL> time.
391 The F<README> file will be generated at dist generation time, inside the built
392 dist. It will be generated using C<pod2text> on the main module.
394 If a F<README> file exists in the repo, it will be used directly instead of
399 =head1 MAKE COMMMANDS
403 test will be adjusted to include F<xt/> tests by default. This will only apply
404 for authors, not users installing from CPAN.
408 Releases the dist. Before releasing, checks will be done on the dist using the
409 C<preflight> and C<releasetest> commands.
411 Releasing will generate a dist tarball and upload it to CPAN using cpan-upload.
412 It will also create a git tag for the release, and push the tag and branch.
416 If release is run with FAKE_RELEASE=1 set, it will skip uploading to CPAN and
417 pushing to git. A release commit will still be created and tagged locally.
421 Performs a number of checks on the files and repository, ensuring it is in a
422 sane state to do a release. The checks are:
426 =item * All version numbers match
428 =item * The F<MANIFEST> file is up to date
430 =item * The branch is correct
432 =item * There is no existing tag for the version
434 =item * There are no unmerged upstream changes
436 =item * There are no outstanding local changes
438 =item * There is an appropriate staged Changes heading
440 =item * cpan-upload is available
446 Test the dist preparing for a release. This generates a dist dir and runs the
447 tests from inside it. This ensures all appropriate files are included inside
448 the dist. C<RELEASE_TESTING> will be set in the environment.
452 Adds an appropriate changelog heading for the release, and prompts to stage the
457 Bumps the version number. This will try to preserve the length and format of
458 the version number. The least significant digit will be incremented. Versions
459 with underscores will preserve the underscore in the same position.
461 Optionally accepts a C<V> option to set the version to a specific value.
463 The version changes will automatically be committed. Unstaged modifications to
464 the files will be left untouched.
468 The V option will be passed along to the version bumping script. It can accept
469 a space separated list of options, including an explicit version number.
477 Updates version numbers even if they do not match the current expected version
482 Attempts to convert the updated version to a stable version, removing any
487 Attempts to convert the updated version to an alpha version, adding an
488 underscore in an appropriate place.
494 Like bump, but increments the minor segment of the version. This will treat
495 numeric versions as x.yyyzzz format, incrementing the yyy segment.
499 Like bumpminor, but bumping the major segment.
503 Updates Distar and re-runs C<perl Makefile.PL>
507 IRC: #web-simple on irc.perl.org
509 Git repository: L<git://git.shadowcat.co.uk/p5sagit/Distar>
511 Git browser: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit/Distar.git;a=summary>
515 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
519 haarg - Graham Knop (cpan:HAARG) <haarg@cpan.org>
521 ether - Karen Etheridge (cpan:ETHER) <ether@cpan.org>
523 frew - Arthur Axel "fREW" Schmidt (cpan:FREW) <frioux@gmail.com>
525 Mithaldu - Christian Walde (cpan:MITHALDU) <walde.christian@googlemail.com>
529 Copyright (c) 2011-2015 the Distar L</AUTHOR> and L</CONTRIBUTORS>
534 This library is free software and may be distributed under the same terms
535 as perl itself. See L<http://dev.perl.org/licenses/>.