package Distar;
-
use strict;
use warnings FATAL => 'all';
use base qw(Exporter);
use ExtUtils::MakeMaker ();
use ExtUtils::MM ();
-use Config;
-use File::Spec;
-
-our $VERSION = '0.001000';
+our $VERSION = '0.002000';
$VERSION = eval $VERSION;
my $MM_VER = eval $ExtUtils::MakeMaker::VERSION;
our @EXPORT = qw(
- author manifest_include readme_generator run_preflight
+ author manifest_include readme_generator
);
sub import {
'xt' => '.t',
'xt/lib' => '.pm',
'' => qr{[^/]*\.PL},
- '' => qr{Changes|MANIFEST|README|META\.yml},
+ '' => qr{Changes|MANIFEST|README|LICENSE|META\.yml},
'maint' => qr{[^.].*},
);
push @Manifest, @_;
}
-my $readme_generator = <<'README';
- pod2text $(VERSION_FROM) >$(DISTVNAME)/README
- $(NOECHO) cd $(DISTVNAME) && $(ABSPERLRUN) ../Distar/helpers/add-readme-to-manifest
-README
sub readme_generator {
- $readme_generator = shift;
+ die "readme_generator unsupported" if @_ && $_[0];
}
sub write_manifest_skip {
+ my ($mm) = @_;
my @files = @Manifest;
my @parts;
while (my ($dir, $spec) = splice(@files, 0, 2)) {
: die "spec must be string or regexp, was: ${spec} (${\ref $spec})");
push @parts, $re;
}
- my $final = '^(?!'.join('|', map "${_}\$", @parts).')';
+ my $dist_name = $mm->{DISTNAME};
+ my $include = join '|', map "${_}\$", @parts;
+ my $final = "^(?:\Q$dist_name\E-v?[0-9_.]+/|(?!$include))";
open my $skip, '>', 'MANIFEST.SKIP'
or die "can't open MANIFEST.SKIP: $!";
print $skip "${final}\n";
close $skip;
}
-sub run_preflight {
- my $version = $ARGV[0];
-
- my $make = $Config{make};
- my $null = File::Spec->devnull;
-
- system("git fetch");
- if (system("git rev-parse --quiet --verify v$version >$null") == 0) {
- die "Tag v$version already exists!";
- }
-
- require File::Find;
- File::Find::find({ no_chdir => 1, wanted => sub {
- return
- unless -f && /\.pm$/;
- my $file_version = MM->parse_version($_);
- die "Module $_ version $file_version doesn't match dist version $version"
- unless $file_version eq 'undef' || $file_version eq $version;
- }}, 'lib');
-
- for (scalar `"$make" manifest 2>&1 >$null`) {
- $_ && die "$make manifest changed:\n$_ Go check it and retry";
- }
-
- for (scalar `git status`) {
- /^(?:# )?On branch master/ || die "Not on master. EEEK";
- /Your branch is behind|Your branch and .*? have diverged/ && die "Not synced with upstream";
- }
-
- for (scalar `git diff`) {
- length && die "Outstanding changes";
- }
- my $ymd = sprintf(
- "%i-%02i-%02i", (gmtime)[5]+1900, (gmtime)[4]+1, (gmtime)[3]
- );
- my $changes_line = "$version - $ymd\n";
- my @cached = grep /^\+/, `git diff --cached -U0`;
- @cached > 0 or die "Please add:\n\n$changes_line\nto Changes stage Changes (git add Changes)";
- @cached == 2 or die "Pre-commit Changes not just Changes line";
- $cached[0] =~ /^\+\+\+ .\/Changes\n/ or die "Changes not changed";
- $cached[1] eq "+$changes_line" or die "Changes new line should be: \n\n$changes_line ";
-
- { no warnings 'exec'; `cpan-upload -h`; }
- $? and die "cpan-upload not available";
-}
-
{
package Distar::MM;
- our @ISA = @ExtUtils::MM::ISA;
- @ExtUtils::MM::ISA = (__PACKAGE__);
+ our @ISA = @MM::ISA;
+ @MM::ISA = (__PACKAGE__);
sub new {
my ($class, $args) = @_;
return $class->SUPER::new({
LICENSE => 'perl_5',
MIN_PERL_VERSION => '5.006',
- AUTHOR => ($MM_VER >= 6.5702 ? $Distar::Author : $Distar::Author->[0]),
- %$args,
+ AUTHOR => ($MM_VER >= 6.5702 ? $Distar::Author : join(', ', @$Distar::Author)),
ABSTRACT_FROM => $args->{VERSION_FROM},
+ %$args,
test => { TESTS => ($args->{test}{TESTS}||'t/*.t').' xt/*.t xt/*/*.t' },
realclean => { FILES => (
($args->{realclean}{FILES}||'')
sub flush {
my $self = shift;
- Distar::write_manifest_skip();
+ Distar::write_manifest_skip($self);
$self->SUPER::flush(@_);
}
+ sub special_targets {
+ my $self = shift;
+ my $targets = $self->SUPER::special_targets(@_);
+ my $phony_targets = join ' ', qw(
+ preflight
+ check-version
+ check-manifest
+ releasetest
+ release
+ readmefile
+ distmanicheck
+ nextrelease
+ refresh
+ bump
+ bumpmajor
+ bumpminor
+ );
+ $targets =~ s/^(\.PHONY *:.*)/$1 $phony_targets/m;
+ $targets;
+ }
+
sub dist_test {
my $self = shift;
- my $dist_test = $self->SUPER::dist_test(@_);
my $include = '';
if (open my $fh, '<', 'maint/Makefile.include') {
- $include = "\n# --- Makefile.include:\n" . do { local $/; <$fh> };
+ $include = "\n# --- Makefile.include:\n\n" . do { local $/; <$fh> };
+ $include =~ s/\n?\z/\n/;
}
- $dist_test .= <<'END'
+ my @bump_targets =
+ grep { $include !~ /^bump$_(?: +\w+)*:/m } ('', 'minor', 'major');
+
+ my %vars = (
+ REMAKE => join(' ', '$(PERLRUN)', 'Makefile.PL', map { $self->quote_literal($_) } @ARGV),
+ BRANCH => $self->{BRANCH} ||= 'master',
+ CHANGELOG => $self->{CHANGELOG} ||= 'Changes',
+ );
-# --- Distar section:
-preflight:
- perl -IDistar/lib -MDistar -erun_preflight $(VERSION)
-release: preflight
- $(MAKE) disttest
- rm -rf $(DISTVNAME)
+ join('',
+ $self->SUPER::dist_test(@_),
+ "\n\n# --- Distar section:\n\n",
+ (map "$_ = $vars{$_}\n", sort keys %vars),
+ <<'END',
+
+preflight: check-version check-manifest
+ $(ABSPERLRUN) Distar/helpers/preflight $(VERSION) --changelog=$(CHANGELOG) --branch=$(BRANCH)
+check-version:
+ $(ABSPERLRUN) Distar/helpers/check-version $(VERSION) $(TO_INST_PM) $(EXE_FILES)
+check-manifest:
+ $(ABSPERLRUN) Distar/helpers/check-manifest
+releasetest:
+ $(MAKE) disttest RELEASE_TESTING=1 PASTHRU="$(PASTHRU) TEST_FILES=\"$(TEST_FILES)\""
+release: preflight releasetest
+ $(RM_RF) $(DISTVNAME)
$(MAKE) $(DISTVNAME).tar$(SUFFIX)
git commit -a -m "Release commit for $(VERSION)"
git tag v$(VERSION) -m "release v$(VERSION)"
git push origin v$(VERSION) HEAD
distdir: readmefile
readmefile: create_distdir
-END
- . $readme_generator . <<'END';
+ $(NOECHO) $(MAKE) $(DISTVNAME)/README
+$(DISTVNAME)/README: $(VERSION_FROM)
+ $(NOECHO) $(MKPATH) $(DISTVNAME)
+ pod2text $(VERSION_FROM) >$(DISTVNAME)/README
+ $(NOECHO) cd $(DISTVNAME) && $(ABSPERLRUN) ../Distar/helpers/add-to-manifest README
disttest: distmanicheck
distmanicheck: create_distdir
cd $(DISTVNAME) && $(ABSPERLRUN) "-MExtUtils::Manifest=manicheck" -e "exit manicheck"
nextrelease:
- $(ABSPERLRUN) Distar/helpers/add-changelog-heading $(VERSION) Changes
- git add -p Changes
+ $(ABSPERLRUN) Distar/helpers/add-changelog-heading --git $(VERSION) $(CHANGELOG)
+refresh:
+ cd Distar && git pull
+ $(RM_F) $(FIRST_MAKEFILE)
+ $(REMAKE)
END
-
- for my $type ('', 'minor', 'major') {
- if ($include !~ /^bump$type:/m) {
- my $arg = $type || '$(V)';
- $dist_test .= <<"END"
-bump$type:
- Distar/helpers/bump-version \$(VERSION) $arg
- rm Makefile
+ map(sprintf(<<'END', "bump$_", ($_ || '$(V)')), @bump_targets),
+%s:
+ $(ABSPERLRUN) Distar/helpers/bump-version --git $(VERSION) %s
+ $(RM_F) $(FIRST_MAKEFILE)
+ $(REMAKE)
END
- }
- }
-
- $dist_test .= $include . "\n";
-
- return $dist_test;
+ $include,
+ "\n",
+ );
}
}
1;
+__END__
+
+=head1 NAME
+
+Distar - Additions to ExtUtils::MakeMaker for dist authors
+
+=head1 SYNOPSIS
+
+F<Makefile.PL>:
+
+ use ExtUtils::MakeMaker;
+ (do 'maint/Makefile.PL.include' or die $@) unless -f 'META.yml';
+
+ WriteMakefile(...);
+
+F<maint/Makefile.PL.include>:
+
+ BEGIN { -e 'Distar' or system("git clone git://git.shadowcat.co.uk/p5sagit/Distar.git") }
+ use lib 'Distar/lib';
+ use Distar 0.001;
+
+ author 'A. U. Thor <author@cpan.org>';
+
+ manifest_include t => 'test-helper.pl';
+ manifest_include corpus => '.txt';
+
+make commmands:
+
+ $ perl Makefile.PL
+ $ make bump # bump version
+ $ make bump V=2.000000 # bump to specific version
+ $ make bumpminor # bump minor version component
+ $ make bumpmajor # bump major version component
+ $ make nextrelease # add version heading to Changes file
+ $ make releasetest # build dist and test (with xt/ and RELEASE_TESTING=1)
+ $ make preflight # check that repo and file state is release ready
+ $ make release # check releasetest and preflight, then build and
+ # upload to CPAN, tag release, push tag and branch
+
+=head1 DESCRIPTION
+
+L<ExtUtils::MakeMaker> works well enough as development tool for
+builting and testing, but using it to release is annoying and error prone.
+Distar adds just enough to L<ExtUtils::MakeMaker> for it to be a usable dist
+author tool. This includes extra commands for releasing and safety checks, and
+automatic generation of some files. It doesn't require any non-core modules and
+is compatible with old versions of perl.
+
+=head1 FUNCTIONS
+
+=head2 author( $author )
+
+Set the author to include in generated META files. Can be a single entry, or
+an arrayref.
+
+=head2 manifest_include( $dir, $pattern )
+
+Add a pattern to include files in the MANIFEST file, and thus in the generated
+dist files.
+
+The pattern can be either a regex, or a path suffix. It will be applied to the
+full path past the directory specified.
+
+The default files that are always included are: F<.pm> and F<.pod> files in
+F<lib>, F<.t> files in F<t> and F<xt>, F<.pm> files in F<t/lib> and F<xt/lib>,
+F<Changes>, F<MANIFEST>, F<README>, F<LICENSE>, F<META.yml>, and F<.PL> files in
+the dist root, and all files in F<maint>.
+
+=head1 AUTOGENERATED FILES
+
+=over 4
+
+=item F<MANIFEST.SKIP>
+
+The F<MANIFEST.SKIP> will be automatically generated to exclude any files not
+explicitly allowed via C<manifest_include> or the included defaults. It will be
+created (or updated) at C<perl Makefile.PL> time.
+
+=item F<README>
+
+The F<README> file will be generated at dist generation time, inside the built
+dist. It will be generated using C<pod2text> on the main module.
+
+If a F<README> file exists in the repo, it will be used directly instead of
+generating the file.
+
+=back
+
+=head1 MAKE COMMMANDS
+
+=head2 test
+
+test will be adjusted to include F<xt/> tests by default. This will only apply
+for authors, not users installing from CPAN.
+
+=head2 release
+
+Releases the dist. Before releasing, checks will be done on the dist using the
+C<preflight> and C<releasetest> commands.
+
+Releasing will generate a dist tarball and upload it to CPAN using cpan-upload.
+It will also create a git tag for the release, and push the tag and branch.
+
+=head2 preflight
+
+Performs a number of checks on the files and repository, ensuring it is in a
+sane state to do a release. The checks are:
+
+=over 4
+
+=item * All version numbers match
+
+=item * The F<MANIFEST> file is up to date
+
+=item * The branch is correct
+
+=item * There is no existing tag for the version
+
+=item * There are no unmerged upstream changes
+
+=item * There are no outstanding local changes
+
+=item * There is an appropriate staged Changes heading
+
+=item * cpan-upload is available
+
+=back
+
+=head2 releasetest
+
+Test the dist preparing for a release. This generates a dist dir and runs the
+tests from inside it. This ensures all appropriate files are included inside
+the dist. C<RELEASE_TESTING> will be set in the environment.
+
+=head2 nextrelease
+
+Adds an appropriate changelog heading for the release, and prompts to stage the
+change.
+
+=head2 bump
+
+Bumps the version number. This will try to preserve the length and format of
+the version number. The least significant digit will be incremented.
+
+Optionally accepts a C<V> option to set the version to a specific value.
+
+The version changes will automatically be committed. Unstaged modifications to
+the files will be left untouched.
+
+=head2 bumpminor
+
+Like bump, but increments the minor segment of the version. This will treat
+numeric versions as x.yyyzzz format, incrementing the yyy segment.
+
+=head2 bumpmajor
+
+Like bumpminor, but bumping the major segment.
+
+=head2 refresh
+
+Updates Distar and re-runs C<perl Makefile.PL>
+
+=head1 SUPPORT
+
+IRC: #web-simple on irc.perl.org
+
+Git repository: L<git://git.shadowcat.co.uk/p5sagit/Distar>
+
+Git browser: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit/Distar.git;a=summary>
+
+=head1 AUTHOR
+
+mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
+
+=head1 CONTRIBUTORS
+
+haarg - Graham Knop (cpan:HAARG) <haarg@cpan.org>
+
+ether = Karen Etheridge (cpan:ETHER) <ether@cpan.org>
+
+frew - Arthur Axel "fREW" Schmidt (cpan:FREW) <frioux@gmail.com>
+
+Mithaldu - Christian Walde (cpan:MITHALDU) <walde.christian@googlemail.com>
+
+=head1 COPYRIGHT
+
+Copyright (c) 2011-2015 the Distar L</AUTHOR> and L</CONTRIBUTORS>
+as listed above.
+
+=head1 LICENSE
+
+This library is free software and may be distributed under the same terms
+as perl itself. See L<http://dev.perl.org/licenses/>.
+
+=cut
projects / p5sagit/Distar.git / blobdiff