3 use warnings FATAL => 'all';
5 use ExtUtils::MakeMaker ();
9 our $VERSION = '0.002000';
10 $VERSION = eval $VERSION;
12 my $MM_VER = eval $ExtUtils::MakeMaker::VERSION;
15 author manifest_include readme_generator
20 warnings->import(FATAL => 'all');
21 shift->export_to_level(1,@_);
38 '' => qr{Changes|MANIFEST|README|LICENSE|META\.yml},
39 'maint' => qr{[^.].*},
42 sub manifest_include {
46 sub readme_generator {
47 die "readme_generator unsupported" if @_ && $_[0];
50 sub write_manifest_skip {
52 my @files = @Manifest;
54 while (my ($dir, $spec) = splice(@files, 0, 2)) {
55 my $re = ($dir ? $dir.'/' : '').
56 ((ref($spec) eq 'Regexp')
60 # print ref as well as stringification in case of overload ""
61 : die "spec must be string or regexp, was: ${spec} (${\ref $spec})");
64 my $dist_name = $mm->{DISTNAME};
65 my $include = join '|', map "${_}\$", @parts;
66 my $final = "^(?:\Q$dist_name\E-v?[0-9_.]+/|(?!$include))";
67 open my $skip, '>', 'MANIFEST.SKIP'
68 or die "can't open MANIFEST.SKIP: $!";
69 print $skip "${final}\n";
76 @MM::ISA = (__PACKAGE__);
79 my ($class, $args) = @_;
80 return $class->SUPER::new({
82 MIN_PERL_VERSION => '5.006',
83 AUTHOR => ($MM_VER >= 6.5702 ? $Distar::Author : join(', ', @$Distar::Author)),
84 ABSTRACT_FROM => $args->{VERSION_FROM},
86 test => { TESTS => ($args->{test}{TESTS}||'t/*.t').' xt/*.t xt/*/*.t' },
87 realclean => { FILES => (
88 ($args->{realclean}{FILES}||'')
89 . ' Distar/ MANIFEST.SKIP MANIFEST MANIFEST.bak'
96 Distar::write_manifest_skip($self);
97 $self->SUPER::flush(@_);
100 sub special_targets {
102 my $targets = $self->SUPER::special_targets(@_);
103 my $phony_targets = join ' ', qw(
118 $targets =~ s/^(\.PHONY *:.*)/$1 $phony_targets/m;
126 if (open my $fh, '<', 'maint/Makefile.include') {
127 $include = "\n# --- Makefile.include:\n\n" . do { local $/; <$fh> };
128 $include =~ s/\n?\z/\n/;
132 grep { $include !~ /^bump$_(?: +\w+)*:/m } ('', 'minor', 'major');
134 my $distar = File::Spec->catdir(
135 File::Spec->catpath((File::Spec->splitpath(__FILE__))[0,1], ''),
138 my $helpers = File::Spec->catdir($distar, 'helpers');
141 DISTAR => $self->quote_literal($distar),
142 HELPERS => $self->quote_literal($helpers),
143 REMAKE => join(' ', '$(PERLRUN)', 'Makefile.PL', map { $self->quote_literal($_) } @ARGV),
144 BRANCH => $self->{BRANCH} ||= 'master',
145 CHANGELOG => $self->{CHANGELOG} ||= 'Changes',
146 DEV_NULL_STDOUT => ($self->{DEV_NULL} ? '>'.File::Spec->devnull : ''),
151 $self->SUPER::dist_test(@_),
152 "\n\n# --- Distar section:\n\n",
153 (map "$_ = $vars{$_}\n", sort keys %vars),
156 preflight: check-version check-manifest check-cpan-upload
157 $(ABSPERLRUN) $(HELPERS)/preflight $(VERSION) --changelog=$(CHANGELOG) --branch=$(BRANCH)
159 $(ABSPERLRUN) $(HELPERS)/check-version $(VERSION) $(TO_INST_PM) $(EXE_FILES)
161 $(ABSPERLRUN) $(HELPERS)/check-manifest
163 $(NOECHO) cpan-upload -h $(DEV_NULL_STDOUT)
165 $(MAKE) disttest RELEASE_TESTING=1 PASTHRU="$(PASTHRU) TEST_FILES=\"$(TEST_FILES)\""
168 git commit -a -m "Release commit for $(VERSION)"
169 git tag v$(VERSION) -m "release v$(VERSION)"
170 $(RM_RF) $(DISTVNAME)
171 $(MAKE) $(DISTVNAME).tar$(SUFFIX)
172 $(NOECHO) $(MAKE) pushrelease FAKE_RELEASE=$(FAKE_RELEASE)
175 pushrelease$(FAKE_RELEASE) ::
176 cpan-upload $(DISTVNAME).tar$(SUFFIX)
177 git push origin v$(VERSION) HEAD
179 readmefile: create_distdir
180 $(NOECHO) $(MAKE) $(DISTVNAME)/README
181 $(DISTVNAME)/README: $(VERSION_FROM)
182 $(NOECHO) $(MKPATH) $(DISTVNAME)
183 pod2text $(VERSION_FROM) >$(DISTVNAME)/README
184 $(NOECHO) $(ABSPERLRUN) $(HELPERS)/add-to-manifest -d $(DISTVNAME) README
185 disttest: distmanicheck
186 distmanicheck: create_distdir
187 cd $(DISTVNAME) && $(ABSPERLRUN) "-MExtUtils::Manifest=manicheck" -e "exit manicheck"
189 $(ABSPERLRUN) $(HELPERS)/add-changelog-heading --git $(VERSION) $(CHANGELOG)
191 cd $(DISTAR) && git pull
192 $(RM_F) $(FIRST_MAKEFILE)
195 map(sprintf(<<'END', "bump$_", ($_ || '$(V)')), @bump_targets),
197 $(ABSPERLRUN) $(HELPERS)/bump-version --git $(VERSION) %s
198 $(RM_F) $(FIRST_MAKEFILE)
212 Distar - Additions to ExtUtils::MakeMaker for dist authors
218 use ExtUtils::MakeMaker;
219 (do 'maint/Makefile.PL.include' or die $@) unless -f 'META.yml';
223 F<maint/Makefile.PL.include>:
225 BEGIN { -e 'Distar' or system("git clone git://git.shadowcat.co.uk/p5sagit/Distar.git") }
226 use lib 'Distar/lib';
229 author 'A. U. Thor <author@cpan.org>';
231 manifest_include t => 'test-helper.pl';
232 manifest_include corpus => '.txt';
237 $ make bump # bump version
238 $ make bump V=2.000000 # bump to specific version
239 $ make bumpminor # bump minor version component
240 $ make bumpmajor # bump major version component
241 $ make nextrelease # add version heading to Changes file
242 $ make releasetest # build dist and test (with xt/ and RELEASE_TESTING=1)
243 $ make preflight # check that repo and file state is release ready
244 $ make release # check releasetest and preflight, then build and
245 # upload to CPAN, tag release, push tag and branch
249 L<ExtUtils::MakeMaker> works well enough as development tool for
250 builting and testing, but using it to release is annoying and error prone.
251 Distar adds just enough to L<ExtUtils::MakeMaker> for it to be a usable dist
252 author tool. This includes extra commands for releasing and safety checks, and
253 automatic generation of some files. It doesn't require any non-core modules and
254 is compatible with old versions of perl.
258 =head2 author( $author )
260 Set the author to include in generated META files. Can be a single entry, or
263 =head2 manifest_include( $dir, $pattern )
265 Add a pattern to include files in the MANIFEST file, and thus in the generated
268 The pattern can be either a regex, or a path suffix. It will be applied to the
269 full path past the directory specified.
271 The default files that are always included are: F<.pm> and F<.pod> files in
272 F<lib>, F<.t> files in F<t> and F<xt>, F<.pm> files in F<t/lib> and F<xt/lib>,
273 F<Changes>, F<MANIFEST>, F<README>, F<LICENSE>, F<META.yml>, and F<.PL> files in
274 the dist root, and all files in F<maint>.
276 =head1 AUTOGENERATED FILES
280 =item F<MANIFEST.SKIP>
282 The F<MANIFEST.SKIP> will be automatically generated to exclude any files not
283 explicitly allowed via C<manifest_include> or the included defaults. It will be
284 created (or updated) at C<perl Makefile.PL> time.
288 The F<README> file will be generated at dist generation time, inside the built
289 dist. It will be generated using C<pod2text> on the main module.
291 If a F<README> file exists in the repo, it will be used directly instead of
296 =head1 MAKE COMMMANDS
300 test will be adjusted to include F<xt/> tests by default. This will only apply
301 for authors, not users installing from CPAN.
305 Releases the dist. Before releasing, checks will be done on the dist using the
306 C<preflight> and C<releasetest> commands.
308 Releasing will generate a dist tarball and upload it to CPAN using cpan-upload.
309 It will also create a git tag for the release, and push the tag and branch.
313 If release is run with FAKE_RELEASE=1 set, it will skip uploading to CPAN and
314 pushing to git. A release commit will still be created and tagged locally.
318 Performs a number of checks on the files and repository, ensuring it is in a
319 sane state to do a release. The checks are:
323 =item * All version numbers match
325 =item * The F<MANIFEST> file is up to date
327 =item * The branch is correct
329 =item * There is no existing tag for the version
331 =item * There are no unmerged upstream changes
333 =item * There are no outstanding local changes
335 =item * There is an appropriate staged Changes heading
337 =item * cpan-upload is available
343 Test the dist preparing for a release. This generates a dist dir and runs the
344 tests from inside it. This ensures all appropriate files are included inside
345 the dist. C<RELEASE_TESTING> will be set in the environment.
349 Adds an appropriate changelog heading for the release, and prompts to stage the
354 Bumps the version number. This will try to preserve the length and format of
355 the version number. The least significant digit will be incremented.
357 Optionally accepts a C<V> option to set the version to a specific value.
359 The version changes will automatically be committed. Unstaged modifications to
360 the files will be left untouched.
364 Like bump, but increments the minor segment of the version. This will treat
365 numeric versions as x.yyyzzz format, incrementing the yyy segment.
369 Like bumpminor, but bumping the major segment.
373 Updates Distar and re-runs C<perl Makefile.PL>
377 IRC: #web-simple on irc.perl.org
379 Git repository: L<git://git.shadowcat.co.uk/p5sagit/Distar>
381 Git browser: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit/Distar.git;a=summary>
385 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
389 haarg - Graham Knop (cpan:HAARG) <haarg@cpan.org>
391 ether = Karen Etheridge (cpan:ETHER) <ether@cpan.org>
393 frew - Arthur Axel "fREW" Schmidt (cpan:FREW) <frioux@gmail.com>
395 Mithaldu - Christian Walde (cpan:MITHALDU) <walde.christian@googlemail.com>
399 Copyright (c) 2011-2015 the Distar L</AUTHOR> and L</CONTRIBUTORS>
404 This library is free software and may be distributed under the same terms
405 as perl itself. See L<http://dev.perl.org/licenses/>.