[p5sagit/Distar.git] / lib / Distar.pm

package Distar;
use strict;
use warnings FATAL => 'all';
use base qw(Exporter);
use ExtUtils::MakeMaker ();
use ExtUtils::MM ();
use File::Spec ();

our $VERSION = '0.003000';
$VERSION = eval $VERSION;

my $MM_VER = eval $ExtUtils::MakeMaker::VERSION;

our @EXPORT = qw(
  author manifest_include readme_generator
);

sub import {
  strict->import;
  warnings->import(FATAL => 'all');
  if (!(@MM::ISA == 1 && $MM::ISA[0] eq 'Distar::MM')) {
    @Distar::MM::ISA = @MM::ISA;
    @MM::ISA = qw(Distar::MM);
  }
  goto &Exporter::import;
}

sub author {
  our $Author = shift;
  $Author = [ $Author ]
    if !ref $Author;
}

our @Manifest = (
  'lib' => '.pm',
  'lib' => '.pod',
  't' => '.t',
  't/lib' => '.pm',
  'xt' => '.t',
  'xt/lib' => '.pm',
  '' => qr{[^/]*\.PL},
  '' => qr{Changes|MANIFEST|README|LICENSE|META\.yml},
  'maint' => qr{[^.].*},
);

sub manifest_include {
  push @Manifest, @_;
}

sub readme_generator {
  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)) {
    my $re = ($dir ? $dir.'/' : '').
      ((ref($spec) eq 'Regexp')
        ? $spec
        : !ref($spec)
          ? ".*\Q${spec}\E"
            # print ref as well as stringification in case of overload ""
          : die "spec must be string or regexp, was: ${spec} (${\ref $spec})");
    push @parts, $re;
  }
  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;
}

{
  package Distar::MM;

  sub new {
    my ($class, $args) = @_;
    my %test = %{$args->{test}||{}};
    my $tests = $test{TESTS} || 't/*.t';
    $tests !~ /\b\Q$_\E\b/ and $tests .= " $_"
      for 'xt/*.t', 'xt/*/*.t';
    $test{TESTS} = $tests;
    return $class->SUPER::new({
      LICENSE => 'perl_5',
      MIN_PERL_VERSION => '5.006',
      ($Distar::Author ? (
        AUTHOR => ($MM_VER >= 6.5702 ? $Distar::Author : join(', ', @$Distar::Author)),
      ) : ()),
      (exists $args->{ABSTRACT} ? () : (ABSTRACT_FROM => $args->{VERSION_FROM})),
      %$args,
      test => \%test,
      realclean => { FILES => (
        ($args->{realclean}{FILES}||'')
        . ' Distar/ MANIFEST.SKIP MANIFEST MANIFEST.bak'
      ) },
    });
  }

  sub flush {
    my $self = shift;
    `git ls-files --error-unmatch MANIFEST.SKIP 2>&1`;
    my $maniskip_tracked = !$?;

    Distar::write_manifest_skip($self)
      unless $maniskip_tracked;
    $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
      check-cpan-upload
      releasetest
      release
      readmefile
      distmanicheck
      nextrelease
      refresh
      bump
      bumpmajor
      bumpminor
    );
    $targets =~ s/^(\.PHONY *:.*)/$1 $phony_targets/m;
    $targets;
  }

  sub init_dist {
    my $self = shift;
    my $pre_tar = $self->{TAR};
    my $out = $self->SUPER::init_dist(@_);

    my $tar = $self->{TAR};
    my $gtar;
    my $set_user;
    my $version = `$tar --version`;
    if ($version =~ /GNU tar/) {
      $gtar = 1;
    }
    elsif (!$pre_tar && `gtar --version`) {
      $tar = 'gtar';
      $gtar = 1;
    }
    my $tarflags = $self->{TARFLAGS};
    if (my ($flags) = $tarflags =~ /^-?([cvhlLf]+)$/) {
      if ($flags =~ s/c// && $flags =~ s/f//) {
        $tarflags = '--format=ustar -c'.$flags.'f';
        if ($gtar) {
          $tarflags = '--owner=0 --group=0 '.$tarflags;
          $set_user = 1;
        }
      }
    }

    if (!$set_user) {
      my $warn = '';
      if ($> >= 2**21) {
        $warn .= "uid ($>)";
      }
      if ($) >= 2**21) {
        $warn .= ($warn ? ' and ' : '').'gid('.(0+$)).')';
      }
      if ($warn) {
        warn "$warn too large!  Max is ".(2**21-1).".\n"
          ."Dist creation will likely fail.  Install GNU tar to work around.\n";
      }
    }

    $self->{TAR} = $tar;
    $self->{TARFLAGS} = $tarflags;

    $out;
  }

  sub tarfile_target {
    my $self = shift;
    my $out = $self->SUPER::tarfile_target(@_);
    my $verify = <<'END_FRAG';
	$(ABSPERLRUN) $(HELPERS)/verify-tarball $(DISTVNAME).tar $(DISTVNAME)/MANIFEST --tar="$(TAR)"
END_FRAG
    $out =~ s{(\$\(TAR\).*\n)}{$1$verify};
    $out;
  }

  sub dist_test {
    my $self = shift;

    my $include = '';
    if (open my $fh, '<', 'maint/Makefile.include') {
      $include = "\n# --- Makefile.include:\n\n" . do { local $/; <$fh> };
      $include =~ s/\n?\z/\n/;
    }

    my @bump_targets =
      grep { $include !~ /^bump$_(?: +\w+)*:/m } ('', 'minor', 'major');

    my $distar_lib = File::Basename::dirname(__FILE__);
    my $helpers = File::Spec->catdir($distar_lib, File::Spec->updir, 'helpers');

    my $licenses = $self->{LICENSE} || $self->{META_ADD}{license} || $self->{META_MERGE}{license};
    my $authors = $self->{AUTHOR};
    $_ = ref $_ ? $_ : [$_ || ()]
      for $licenses, $authors;

    my %vars = (
      DISTAR_LIB => $self->quote_literal($distar_lib),
      HELPERS => $self->quote_literal($helpers),
      REMAKE => join(' ', '$(PERLRUN)', '-I$(DISTAR_LIB)', '-MDistar', 'Makefile.PL', map { $self->quote_literal($_) } @ARGV),
      BRANCH => $self->{BRANCH} ||= 'master',
      CHANGELOG => $self->{CHANGELOG} ||= 'Changes',
      DEV_NULL_STDOUT => ($self->{DEV_NULL} ? '>'.File::Spec->devnull : ''),
      DISTTEST_MAKEFILE_PARAMS => '',
      AUTHORS => $self->quote_literal(join(', ', @$authors)),
      LICENSES => join(' ', map $self->quote_literal($_), @$licenses),
      GET_CHANGELOG => '$(ABSPERLRUN) $(HELPERS)/get-changelog $(VERSION) $(CHANGELOG)',
      UPDATE_DISTAR => (
        -e File::Spec->catdir($distar_lib, File::Spec->updir, '.git')
          ? 'git -C $(DISTAR_LIB) pull'
          : '$(ECHO) "Distar code is not in a git repo, unable to update!"'
      ),
    );

    my $dist_test = $self->SUPER::dist_test(@_);
    $dist_test =~ s/(\bMakefile\.PL\b)/$1 \$(DISTTEST_MAKEFILE_PARAMS)/;

    join('',
      $dist_test,
      "\n\n# --- Distar section:\n\n",
      (map "$_ = $vars{$_}\n", sort keys %vars),
      <<'END',

preflight: check-version check-manifest check-cpan-upload
	$(ABSPERLRUN) $(HELPERS)/preflight $(VERSION) --changelog=$(CHANGELOG) --branch=$(BRANCH)
check-version:
	$(ABSPERLRUN) $(HELPERS)/check-version $(VERSION) $(TO_INST_PM) $(EXE_FILES)
check-manifest:
	$(ABSPERLRUN) $(HELPERS)/check-manifest
check-cpan-upload:
	$(NOECHO) cpan-upload -h $(DEV_NULL_STDOUT)
releasetest:
	$(MAKE) disttest RELEASE_TESTING=1 DISTTEST_MAKEFILE_PARAMS="PREREQ_FATAL=1" PASTHRU="$(PASTHRU) TEST_FILES=\"$(TEST_FILES)\""
release: preflight
	$(MAKE) releasetest
	$(GET_CHANGELOG) -p"Release commit for $(VERSION)" | git commit -a -F -
	$(GET_CHANGELOG) -p"release v$(VERSION)" | git tag -a -F - "v$(VERSION)"
	$(RM_RF) $(DISTVNAME)
	$(MAKE) $(DISTVNAME).tar$(SUFFIX)
	$(NOECHO) $(MAKE) pushrelease FAKE_RELEASE=$(FAKE_RELEASE)
pushrelease ::
	$(NOECHO) $(NOOP)
pushrelease$(FAKE_RELEASE) ::
	cpan-upload $(DISTVNAME).tar$(SUFFIX)
	git push origin v$(VERSION) HEAD
distdir: readmefile licensefile
readmefile: create_distdir
	$(NOECHO) $(TEST_F) $(DISTVNAME)/README || $(MAKE) $(DISTVNAME)/README
$(DISTVNAME)/README: $(VERSION_FROM)
	$(NOECHO) $(MKPATH) $(DISTVNAME)
	pod2text $(VERSION_FROM) >$(DISTVNAME)/README
	$(NOECHO) $(ABSPERLRUN) $(HELPERS)/add-to-manifest -d $(DISTVNAME) README
distsignature: readmefile licensefile
licensefile: create_distdir
	$(NOECHO) $(TEST_F) $(DISTVNAME)/LICENSE || $(MAKE) $(DISTVNAME)/LICENSE
$(DISTVNAME)/LICENSE: Makefile.PL
	$(NOECHO) $(MKPATH) $(DISTVNAME)
	$(ABSPERLRUN) $(HELPERS)/generate-license $(AUTHORS) $(LICENSES) >$(DISTVNAME)/LICENSE
	$(NOECHO) $(ABSPERLRUN) $(HELPERS)/add-to-manifest -d $(DISTVNAME) LICENSE
disttest: distmanicheck
distmanicheck: create_distdir
	cd $(DISTVNAME) && $(ABSPERLRUN) "-MExtUtils::Manifest=manicheck" -e "exit manicheck"
nextrelease:
	$(ABSPERLRUN) $(HELPERS)/add-changelog-heading --git $(VERSION) $(CHANGELOG)
refresh:
	$(UPDATE_DISTAR)
	$(RM_F) $(FIRST_MAKEFILE)
	$(REMAKE)
END
      map(sprintf(<<'END', "bump$_", ($_ || '$(V)')), @bump_targets),
%s:
	$(ABSPERLRUN) $(HELPERS)/bump-version --git $(VERSION) %s
	$(RM_F) $(FIRST_MAKEFILE)
	$(REMAKE)
END
      $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, commits and tags,
                          # builds and uploads to CPAN, and pushes commits and
                          # tag
  $ make release FAKE_RELEASE=1
                          # builds a release INCLUDING committing and tagging,
                          # but does not upload to cpan or push anything to git

=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.

=head3 FAKE_RELEASE

If release is run with FAKE_RELEASE=1 set, it will skip uploading to CPAN and
pushing to git.  A release commit will still be created and tagged locally.

=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.  Versions
with underscores will preserve the underscore in the same position.

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.

=head3 V

The V option will be passed along to the version bumping script.  It can accept
a space separated list of options, including an explicit version number.

Options:

=over 4

=item --force

Updates version numbers even if they do not match the current expected version
number.

=item --stable

Attempts to convert the updated version to a stable version, removing any
underscore.

=item --alpha

Attempts to convert the updated version to an alpha version, adding an
underscore in an appropriate place.

=back

=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
Commit	Line	Data
42e08a83	1	package Distar;
362ec4af	2	use strict;
362ec4af	3	use warnings FATAL => 'all';
42e08a83	4	use base qw(Exporter);
ca3b3b8a	5	use ExtUtils::MakeMaker ();
ca3b3b8a	6	use ExtUtils::MM ();
8aac77fc	7	use File::Spec ();
42e08a83	8
2b085b99	9	our $VERSION = '0.003000';
37e295d8	10	$VERSION = eval $VERSION;
37e295d8	11
e076eedb	12	my $MM_VER = eval $ExtUtils::MakeMaker::VERSION;
e076eedb	13
42e08a83	14	our @EXPORT = qw(
be032607	15	author manifest_include readme_generator
42e08a83	16	);
	17
	18	sub import {
2852faf3	19	strict->import;
2852faf3	20	warnings->import(FATAL => 'all');
f5cc9f53	21	if (!(@MM::ISA == 1 && $MM::ISA[0] eq 'Distar::MM')) {
	22	@Distar::MM::ISA = @MM::ISA;
	23	@MM::ISA = qw(Distar::MM);
	24	}
788b7f10	25	goto &Exporter::import;
42e08a83	26	}
42e08a83	27
e076eedb	28	sub author {
	29	our $Author = shift;
	30	$Author = [ $Author ]
	31	if !ref $Author;
	32	}
42e08a83	33
	34	our @Manifest = (
	35	'lib' => '.pm',
7b9318ce	36	'lib' => '.pod',
42e08a83	37	't' => '.t',
	38	't/lib' => '.pm',
	39	'xt' => '.t',
	40	'xt/lib' => '.pm',
1d950b4a	41	'' => qr{[^/]*\.PL},
f1ef306e	42	'' => qr{Changes\|MANIFEST\|README\|LICENSE\|META\.yml},
42e08a83	43	'maint' => qr{[^.].*},
	44	);
	45
	46	sub manifest_include {
	47	push @Manifest, @_;
	48	}
	49
6e83c113	50	sub readme_generator {
f6286f60	51	die "readme_generator unsupported" if @_ && $_[0];
6e83c113	52	}
6e83c113	53
42e08a83	54	sub write_manifest_skip {
0fa73f76	55	my ($mm) = @_;
42e08a83	56	my @files = @Manifest;
	57	my @parts;
	58	while (my ($dir, $spec) = splice(@files, 0, 2)) {
	59	my $re = ($dir ? $dir.'/' : '').
	60	((ref($spec) eq 'Regexp')
	61	? $spec
	62	: !ref($spec)
	63	? ".*\Q${spec}\E"
a3e39afd	64	# print ref as well as stringification in case of overload ""
42e08a83	65	: die "spec must be string or regexp, was: ${spec} (${\ref $spec})");
	66	push @parts, $re;
	67	}
0fa73f76	68	my $dist_name = $mm->{DISTNAME};
	69	my $include = join '\|', map "${_}\$", @parts;
	70	my $final = "^(?:\Q$dist_name\E-v?[0-9_.]+/\|(?!$include))";
19916679	71	open my $skip, '>', 'MANIFEST.SKIP'
19916679	72	or die "can't open MANIFEST.SKIP: $!";
42e08a83	73	print $skip "${final}\n";
	74	close $skip;
	75	}
	76
ca3b3b8a	77	{
ca3b3b8a	78	package Distar::MM;
ca3b3b8a	79
	80	sub new {
	81	my ($class, $args) = @_;
4762e03a	82	my %test = %{$args->{test}\|\|{}};
	83	my $tests = $test{TESTS} \|\| 't/*.t';
	84	$tests !~ /\b\Q$_\E\b/ and $tests .= " $_"
	85	for 'xt/.t', 'xt//*.t';
	86	$test{TESTS} = $tests;
ca3b3b8a	87	return $class->SUPER::new({
180e908e	88	LICENSE => 'perl_5',
53e1282f	89	MIN_PERL_VERSION => '5.006',
15f10a18	90	($Distar::Author ? (
d0f7a429	91	AUTHOR => ($MM_VER >= 6.5702 ? $Distar::Author : join(', ', @$Distar::Author)),
d0f7a429	92	) : ()),
1f136c70	93	(exists $args->{ABSTRACT} ? () : (ABSTRACT_FROM => $args->{VERSION_FROM})),
4a4bb570	94	%$args,
4762e03a	95	test => \%test,
0a3fdb23	96	realclean => { FILES => (
	97	($args->{realclean}{FILES}\|\|'')
	98	. ' Distar/ MANIFEST.SKIP MANIFEST MANIFEST.bak'
	99	) },
ca3b3b8a	100	});
	101	}
	102
eddb1ce6	103	sub flush {
eddb1ce6	104	my $self = shift;
5371ff52	105	`git ls-files --error-unmatch MANIFEST.SKIP 2>&1`;
	106	my $maniskip_tracked = !$?;
	107
	108	Distar::write_manifest_skip($self)
	109	unless $maniskip_tracked;
eddb1ce6	110	$self->SUPER::flush(@_);
	111	}
	112
7efea54c	113	sub special_targets {
	114	my $self = shift;
	115	my $targets = $self->SUPER::special_targets(@_);
f57289e3	116	my $phony_targets = join ' ', qw(
f57289e3	117	preflight
7b418de8	118	check-version
5baee32c	119	check-manifest
b0780d0a	120	check-cpan-upload
f57289e3	121	releasetest
	122	release
	123	readmefile
	124	distmanicheck
	125	nextrelease
	126	refresh
	127	bump
	128	bumpmajor
	129	bumpminor
	130	);
	131	$targets =~ s/^(\.PHONY :.)/$1 $phony_targets/m;
7efea54c	132	$targets;
	133	}
	134
42d0b436	135	sub init_dist {
	136	my $self = shift;
	137	my $pre_tar = $self->{TAR};
	138	my $out = $self->SUPER::init_dist(@_);
	139
	140	my $tar = $self->{TAR};
	141	my $gtar;
	142	my $set_user;
	143	my $version = `$tar --version`;
	144	if ($version =~ /GNU tar/) {
	145	$gtar = 1;
	146	}
	147	elsif (!$pre_tar && `gtar --version`) {
	148	$tar = 'gtar';
	149	$gtar = 1;
	150	}
	151	my $tarflags = $self->{TARFLAGS};
	152	if (my ($flags) = $tarflags =~ /^-?([cvhlLf]+)$/) {
	153	if ($flags =~ s/c// && $flags =~ s/f//) {
	154	$tarflags = '--format=ustar -c'.$flags.'f';
	155	if ($gtar) {
	156	$tarflags = '--owner=0 --group=0 '.$tarflags;
	157	$set_user = 1;
	158	}
	159	}
	160	}
	161
	162	if (!$set_user) {
	163	my $warn = '';
	164	if ($> >= 2**21) {
	165	$warn .= "uid ($>)";
	166	}
	167	if ($) >= 2**21) {
	168	$warn .= ($warn ? ' and ' : '').'gid('.(0+$)).')';
	169	}
	170	if ($warn) {
	171	warn "$warn too large! Max is ".(2**21-1).".\n"
	172	."Dist creation will likely fail. Install GNU tar to work around.\n";
	173	}
	174	}
	175
	176	$self->{TAR} = $tar;
	177	$self->{TARFLAGS} = $tarflags;
	178
	179	$out;
	180	}
	181
ee801c00	182	sub tarfile_target {
	183	my $self = shift;
	184	my $out = $self->SUPER::tarfile_target(@_);
	185	my $verify = <<'END_FRAG';
	186	$(ABSPERLRUN) $(HELPERS)/verify-tarball $(DISTVNAME).tar $(DISTVNAME)/MANIFEST --tar="$(TAR)"
	187	END_FRAG
	188	$out =~ s{(\$\(TAR\).*\n)}{$1$verify};
	189	$out;
	190	}
	191
ca3b3b8a	192	sub dist_test {
ca3b3b8a	193	my $self = shift;
8ab5ea70	194
66a2ecde	195	my $include = '';
	196	if (open my $fh, '<', 'maint/Makefile.include') {
	197	$include = "\n# --- Makefile.include:\n\n" . do { local $/; <$fh> };
	198	$include =~ s/\n?\z/\n/;
	199	}
b0401762	200
66a2ecde	201	my @bump_targets =
66a2ecde	202	grep { $include !~ /^bump$_(?: +\w+)*:/m } ('', 'minor', 'major');
81d518f6	203
7e3a1558	204	my $distar_lib = File::Basename::dirname(__FILE__);
7e3a1558	205	my $helpers = File::Spec->catdir($distar_lib, File::Spec->updir, 'helpers');
8aac77fc	206
c97878e5	207	my $licenses = $self->{LICENSE} \|\| $self->{META_ADD}{license} \|\| $self->{META_MERGE}{license};
	208	my $authors = $self->{AUTHOR};
	209	$_ = ref $_ ? $_ : [$_ \|\| ()]
	210	for $licenses, $authors;
	211
66a2ecde	212	my %vars = (
7e3a1558	213	DISTAR_LIB => $self->quote_literal($distar_lib),
8aac77fc	214	HELPERS => $self->quote_literal($helpers),
7e3a1558	215	REMAKE => join(' ', '$(PERLRUN)', '-I$(DISTAR_LIB)', '-MDistar', 'Makefile.PL', map { $self->quote_literal($_) } @ARGV),
190976f8	216	BRANCH => $self->{BRANCH} \|\|= 'master',
9b920c5c	217	CHANGELOG => $self->{CHANGELOG} \|\|= 'Changes',
b0780d0a	218	DEV_NULL_STDOUT => ($self->{DEV_NULL} ? '>'.File::Spec->devnull : ''),
f0bbeff7	219	DISTTEST_MAKEFILE_PARAMS => '',
c97878e5	220	AUTHORS => $self->quote_literal(join(', ', @$authors)),
c97878e5	221	LICENSES => join(' ', map $self->quote_literal($_), @$licenses),
c6b7b384	222	GET_CHANGELOG => '$(ABSPERLRUN) $(HELPERS)/get-changelog $(VERSION) $(CHANGELOG)',
7e3a1558	223	UPDATE_DISTAR => (
	224	-e File::Spec->catdir($distar_lib, File::Spec->updir, '.git')
	225	? 'git -C $(DISTAR_LIB) pull'
	226	: '$(ECHO) "Distar code is not in a git repo, unable to update!"'
	227	),
66a2ecde	228	);
66a2ecde	229
f0bbeff7	230	my $dist_test = $self->SUPER::dist_test(@_);
	231	$dist_test =~ s/(\bMakefile\.PL\b)/$1 \$(DISTTEST_MAKEFILE_PARAMS)/;
	232
66a2ecde	233	join('',
f0bbeff7	234	$dist_test,
66a2ecde	235	"\n\n# --- Distar section:\n\n",
	236	(map "$_ = $vars{$_}\n", sort keys %vars),
	237	<<'END',
81d518f6	238
b0780d0a	239	preflight: check-version check-manifest check-cpan-upload
8aac77fc	240	$(ABSPERLRUN) $(HELPERS)/preflight $(VERSION) --changelog=$(CHANGELOG) --branch=$(BRANCH)
7b418de8	241	check-version:
8aac77fc	242	$(ABSPERLRUN) $(HELPERS)/check-version $(VERSION) $(TO_INST_PM) $(EXE_FILES)
5baee32c	243	check-manifest:
8aac77fc	244	$(ABSPERLRUN) $(HELPERS)/check-manifest
b0780d0a	245	check-cpan-upload:
b0780d0a	246	$(NOECHO) cpan-upload -h $(DEV_NULL_STDOUT)
3e632431	247	releasetest:
f0bbeff7	248	$(MAKE) disttest RELEASE_TESTING=1 DISTTEST_MAKEFILE_PARAMS="PREREQ_FATAL=1" PASTHRU="$(PASTHRU) TEST_FILES=\"$(TEST_FILES)\""
49beea48	249	release: preflight
49beea48	250	$(MAKE) releasetest
c6b7b384	251	$(GET_CHANGELOG) -p"Release commit for $(VERSION)" \| git commit -a -F -
c6b7b384	252	$(GET_CHANGELOG) -p"release v$(VERSION)" \| git tag -a -F - "v$(VERSION)"
49beea48	253	$(RM_RF) $(DISTVNAME)
49beea48	254	$(MAKE) $(DISTVNAME).tar$(SUFFIX)
263b723e	255	$(NOECHO) $(MAKE) pushrelease FAKE_RELEASE=$(FAKE_RELEASE)
	256	pushrelease ::
	257	$(NOECHO) $(NOOP)
	258	pushrelease$(FAKE_RELEASE) ::
65a1f7d9	259	cpan-upload $(DISTVNAME).tar$(SUFFIX)
2c636792	260	git push origin v$(VERSION) HEAD
c97878e5	261	distdir: readmefile licensefile
75f8311c	262	readmefile: create_distdir
5c5deb0a	263	$(NOECHO) $(TEST_F) $(DISTVNAME)/README \|\| $(MAKE) $(DISTVNAME)/README
f6286f60	264	$(DISTVNAME)/README: $(VERSION_FROM)
	265	$(NOECHO) $(MKPATH) $(DISTVNAME)
	266	pod2text $(VERSION_FROM) >$(DISTVNAME)/README
8aac77fc	267	$(NOECHO) $(ABSPERLRUN) $(HELPERS)/add-to-manifest -d $(DISTVNAME) README
c97878e5	268	distsignature: readmefile licensefile
	269	licensefile: create_distdir
	270	$(NOECHO) $(TEST_F) $(DISTVNAME)/LICENSE \|\| $(MAKE) $(DISTVNAME)/LICENSE
	271	$(DISTVNAME)/LICENSE: Makefile.PL
	272	$(NOECHO) $(MKPATH) $(DISTVNAME)
	273	$(ABSPERLRUN) $(HELPERS)/generate-license $(AUTHORS) $(LICENSES) >$(DISTVNAME)/LICENSE
c97878e5	274	$(NOECHO) $(ABSPERLRUN) $(HELPERS)/add-to-manifest -d $(DISTVNAME) LICENSE
de048fa8	275	disttest: distmanicheck
792c9e91	276	distmanicheck: create_distdir
792c9e91	277	cd $(DISTVNAME) && $(ABSPERLRUN) "-MExtUtils::Manifest=manicheck" -e "exit manicheck"
e7a78651	278	nextrelease:
8aac77fc	279	$(ABSPERLRUN) $(HELPERS)/add-changelog-heading --git $(VERSION) $(CHANGELOG)
0edb27b8	280	refresh:
7e3a1558	281	$(UPDATE_DISTAR)
e9f66489	282	$(RM_F) $(FIRST_MAKEFILE)
0edb27b8	283	$(REMAKE)
8ab5ea70	284	END
66a2ecde	285	map(sprintf(<<'END', "bump$_", ($_ \|\| '$(V)')), @bump_targets),
66a2ecde	286	%s:
8aac77fc	287	$(ABSPERLRUN) $(HELPERS)/bump-version --git $(VERSION) %s
66a2ecde	288	$(RM_F) $(FIRST_MAKEFILE)
66a2ecde	289	$(REMAKE)
42e08a83	290	END
66a2ecde	291	$include,
	292	"\n",
	293	);
42e08a83	294	}
	295	}
	296
42e08a83	297	1;
edb4539a	298	__END__
	299
	300	=head1 NAME
	301
	302	Distar - Additions to ExtUtils::MakeMaker for dist authors
	303
	304	=head1 SYNOPSIS
	305
	306	F<Makefile.PL>:
	307
	308	use ExtUtils::MakeMaker;
83e12da3	309	(do './maint/Makefile.PL.include' or die $@) unless -f 'META.yml';
edb4539a	310
	311	WriteMakefile(...);
	312
	313	F<maint/Makefile.PL.include>:
	314
	315	BEGIN { -e 'Distar' or system("git clone git://git.shadowcat.co.uk/p5sagit/Distar.git") }
	316	use lib 'Distar/lib';
	317	use Distar 0.001;
	318
	319	author 'A. U. Thor <author@cpan.org>';
	320
	321	manifest_include t => 'test-helper.pl';
	322	manifest_include corpus => '.txt';
	323
	324	make commmands:
	325
	326	$ perl Makefile.PL
	327	$ make bump # bump version
	328	$ make bump V=2.000000 # bump to specific version
	329	$ make bumpminor # bump minor version component
	330	$ make bumpmajor # bump major version component
	331	$ make nextrelease # add version heading to Changes file
	332	$ make releasetest # build dist and test (with xt/ and RELEASE_TESTING=1)
	333	$ make preflight # check that repo and file state is release ready
83e12da3	334	$ make release # check releasetest and preflight, commits and tags,
	335	# builds and uploads to CPAN, and pushes commits and
	336	# tag
	337	$ make release FAKE_RELEASE=1
	338	# builds a release INCLUDING committing and tagging,
	339	# but does not upload to cpan or push anything to git
edb4539a	340
	341	=head1 DESCRIPTION
	342
	343	L<ExtUtils::MakeMaker> works well enough as development tool for
	344	builting and testing, but using it to release is annoying and error prone.
	345	Distar adds just enough to L<ExtUtils::MakeMaker> for it to be a usable dist
	346	author tool. This includes extra commands for releasing and safety checks, and
	347	automatic generation of some files. It doesn't require any non-core modules and
	348	is compatible with old versions of perl.
	349
	350	=head1 FUNCTIONS
	351
	352	=head2 author( $author )
	353
	354	Set the author to include in generated META files. Can be a single entry, or
	355	an arrayref.
	356
	357	=head2 manifest_include( $dir, $pattern )
	358
	359	Add a pattern to include files in the MANIFEST file, and thus in the generated
	360	dist files.
	361
	362	The pattern can be either a regex, or a path suffix. It will be applied to the
	363	full path past the directory specified.
	364
	365	The default files that are always included are: F<.pm> and F<.pod> files in
	366	F<lib>, F<.t> files in F<t> and F<xt>, F<.pm> files in F<t/lib> and F<xt/lib>,
	367	F<Changes>, F<MANIFEST>, F<README>, F<LICENSE>, F<META.yml>, and F<.PL> files in
	368	the dist root, and all files in F<maint>.
	369
	370	=head1 AUTOGENERATED FILES
	371
	372	=over 4
	373
	374	=item F<MANIFEST.SKIP>
	375
	376	The F<MANIFEST.SKIP> will be automatically generated to exclude any files not
	377	explicitly allowed via C<manifest_include> or the included defaults. It will be
	378	created (or updated) at C<perl Makefile.PL> time.
	379
	380	=item F<README>
	381
	382	The F<README> file will be generated at dist generation time, inside the built
	383	dist. It will be generated using C<pod2text> on the main module.
	384
	385	If a F<README> file exists in the repo, it will be used directly instead of
	386	generating the file.
	387
	388	=back
	389
	390	=head1 MAKE COMMMANDS
	391
	392	=head2 test
	393
	394	test will be adjusted to include F<xt/> tests by default. This will only apply
	395	for authors, not users installing from CPAN.
	396
	397	=head2 release
	398
	399	Releases the dist. Before releasing, checks will be done on the dist using the
	400	C<preflight> and C<releasetest> commands.
	401
	402	Releasing will generate a dist tarball and upload it to CPAN using cpan-upload.
	403	It will also create a git tag for the release, and push the tag and branch.
404
83e12da3	405	=head3 FAKE_RELEASE
263b723e	406
	407	If release is run with FAKE_RELEASE=1 set, it will skip uploading to CPAN and
	408	pushing to git. A release commit will still be created and tagged locally.
	409
edb4539a	410	=head2 preflight
	411
	412	Performs a number of checks on the files and repository, ensuring it is in a
	413	sane state to do a release. The checks are:
	414
	415	=over 4
	416
	417	=item * All version numbers match
	418
	419	=item * The F<MANIFEST> file is up to date
	420
	421	=item * The branch is correct
	422
	423	=item * There is no existing tag for the version
	424
	425	=item * There are no unmerged upstream changes
	426
	427	=item * There are no outstanding local changes
	428
	429	=item * There is an appropriate staged Changes heading
	430
	431	=item * cpan-upload is available
	432
	433	=back
	434
	435	=head2 releasetest
	436
	437	Test the dist preparing for a release. This generates a dist dir and runs the
	438	tests from inside it. This ensures all appropriate files are included inside
	439	the dist. C<RELEASE_TESTING> will be set in the environment.
	440
	441	=head2 nextrelease
	442
	443	Adds an appropriate changelog heading for the release, and prompts to stage the
	444	change.
	445
	446	=head2 bump
	447
	448	Bumps the version number. This will try to preserve the length and format of
83e12da3	449	the version number. The least significant digit will be incremented. Versions
83e12da3	450	with underscores will preserve the underscore in the same position.
edb4539a	451
	452	Optionally accepts a C<V> option to set the version to a specific value.
	453
	454	The version changes will automatically be committed. Unstaged modifications to
	455	the files will be left untouched.
	456
83e12da3	457	=head3 V
	458
	459	The V option will be passed along to the version bumping script. It can accept
	460	a space separated list of options, including an explicit version number.
	461
	462	Options:
	463
	464	=over 4
	465
	466	=item --force
	467
	468	Updates version numbers even if they do not match the current expected version
	469	number.
	470
	471	=item --stable
	472
	473	Attempts to convert the updated version to a stable version, removing any
	474	underscore.
	475
	476	=item --alpha
	477
	478	Attempts to convert the updated version to an alpha version, adding an
	479	underscore in an appropriate place.
	480
	481	=back
	482
edb4539a	483	=head2 bumpminor
	484
	485	Like bump, but increments the minor segment of the version. This will treat
	486	numeric versions as x.yyyzzz format, incrementing the yyy segment.
	487
	488	=head2 bumpmajor
	489
	490	Like bumpminor, but bumping the major segment.
	491
	492	=head2 refresh
	493
	494	Updates Distar and re-runs C<perl Makefile.PL>
	495
	496	=head1 SUPPORT
	497
	498	IRC: #web-simple on irc.perl.org
	499
	500	Git repository: L<git://git.shadowcat.co.uk/p5sagit/Distar>
	501
	502	Git browser: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit/Distar.git;a=summary>
	503
	504	=head1 AUTHOR
	505
	506	mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
	507
	508	=head1 CONTRIBUTORS
	509
	510	haarg - Graham Knop (cpan:HAARG) <haarg@cpan.org>
	511
83e12da3	512	ether - Karen Etheridge (cpan:ETHER) <ether@cpan.org>
edb4539a	513
	514	frew - Arthur Axel "fREW" Schmidt (cpan:FREW) <frioux@gmail.com>
	515
	516	Mithaldu - Christian Walde (cpan:MITHALDU) <walde.christian@googlemail.com>
	517
	518	=head1 COPYRIGHT
	519
	520	Copyright (c) 2011-2015 the Distar L</AUTHOR> and L</CONTRIBUTORS>
	521	as listed above.
	522
	523	=head1 LICENSE
	524
	525	This library is free software and may be distributed under the same terms
	526	as perl itself. See L<http://dev.perl.org/licenses/>.
	527
	528	=cut