[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.002000';
$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');
  shift->export_to_level(1,@_);
}

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;
  our @ISA = @MM::ISA;
  @MM::ISA = (__PACKAGE__);

  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',
      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 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 = File::Spec->catdir(
      File::Spec->catpath((File::Spec->splitpath(__FILE__))[0,1], ''),
      File::Spec->updir,
    );
    my $helpers = File::Spec->catdir($distar, 'helpers');

    my %vars = (
      DISTAR => $self->quote_literal($distar),
      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 : ''),
      FAKE_RELEASE => '',
    );

    join('',
      $self->SUPER::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 PASTHRU="$(PASTHRU) TEST_FILES=\"$(TEST_FILES)\""
release: preflight
	$(MAKE) releasetest
	git commit -a -m "Release commit for $(VERSION)"
	git tag v$(VERSION) -m "release 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
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
disttest: distmanicheck
distmanicheck: create_distdir
	cd $(DISTVNAME) && $(ABSPERLRUN) "-MExtUtils::Manifest=manicheck" -e "exit manicheck"
nextrelease:
	$(ABSPERLRUN) $(HELPERS)/add-changelog-heading --git $(VERSION) $(CHANGELOG)
refresh:
	cd $(DISTAR) && git pull
	$(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, 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 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.

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
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
f6286f60	9	our $VERSION = '0.002000';
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');
42e08a83	21	shift->export_to_level(1,@_);
	22	}
	23
e076eedb	24	sub author {
	25	our $Author = shift;
	26	$Author = [ $Author ]
	27	if !ref $Author;
	28	}
42e08a83	29
	30	our @Manifest = (
	31	'lib' => '.pm',
7b9318ce	32	'lib' => '.pod',
42e08a83	33	't' => '.t',
	34	't/lib' => '.pm',
	35	'xt' => '.t',
	36	'xt/lib' => '.pm',
1d950b4a	37	'' => qr{[^/]*\.PL},
f1ef306e	38	'' => qr{Changes\|MANIFEST\|README\|LICENSE\|META\.yml},
42e08a83	39	'maint' => qr{[^.].*},
	40	);
	41
	42	sub manifest_include {
	43	push @Manifest, @_;
	44	}
	45
6e83c113	46	sub readme_generator {
f6286f60	47	die "readme_generator unsupported" if @_ && $_[0];
6e83c113	48	}
6e83c113	49
42e08a83	50	sub write_manifest_skip {
0fa73f76	51	my ($mm) = @_;
42e08a83	52	my @files = @Manifest;
	53	my @parts;
	54	while (my ($dir, $spec) = splice(@files, 0, 2)) {
	55	my $re = ($dir ? $dir.'/' : '').
	56	((ref($spec) eq 'Regexp')
	57	? $spec
	58	: !ref($spec)
	59	? ".*\Q${spec}\E"
a3e39afd	60	# print ref as well as stringification in case of overload ""
42e08a83	61	: die "spec must be string or regexp, was: ${spec} (${\ref $spec})");
	62	push @parts, $re;
	63	}
0fa73f76	64	my $dist_name = $mm->{DISTNAME};
	65	my $include = join '\|', map "${_}\$", @parts;
	66	my $final = "^(?:\Q$dist_name\E-v?[0-9_.]+/\|(?!$include))";
19916679	67	open my $skip, '>', 'MANIFEST.SKIP'
19916679	68	or die "can't open MANIFEST.SKIP: $!";
42e08a83	69	print $skip "${final}\n";
	70	close $skip;
	71	}
	72
ca3b3b8a	73	{
ca3b3b8a	74	package Distar::MM;
9af7ff2e	75	our @ISA = @MM::ISA;
9af7ff2e	76	@MM::ISA = (__PACKAGE__);
ca3b3b8a	77
	78	sub new {
	79	my ($class, $args) = @_;
4762e03a	80	my %test = %{$args->{test}\|\|{}};
	81	my $tests = $test{TESTS} \|\| 't/*.t';
	82	$tests !~ /\b\Q$_\E\b/ and $tests .= " $_"
	83	for 'xt/.t', 'xt//*.t';
	84	$test{TESTS} = $tests;
ca3b3b8a	85	return $class->SUPER::new({
180e908e	86	LICENSE => 'perl_5',
53e1282f	87	MIN_PERL_VERSION => '5.006',
0cc25268	88	AUTHOR => ($MM_VER >= 6.5702 ? $Distar::Author : join(', ', @$Distar::Author)),
1f136c70	89	(exists $args->{ABSTRACT} ? () : (ABSTRACT_FROM => $args->{VERSION_FROM})),
4a4bb570	90	%$args,
4762e03a	91	test => \%test,
0a3fdb23	92	realclean => { FILES => (
	93	($args->{realclean}{FILES}\|\|'')
	94	. ' Distar/ MANIFEST.SKIP MANIFEST MANIFEST.bak'
	95	) },
ca3b3b8a	96	});
	97	}
	98
eddb1ce6	99	sub flush {
eddb1ce6	100	my $self = shift;
5371ff52	101	`git ls-files --error-unmatch MANIFEST.SKIP 2>&1`;
	102	my $maniskip_tracked = !$?;
	103
	104	Distar::write_manifest_skip($self)
	105	unless $maniskip_tracked;
eddb1ce6	106	$self->SUPER::flush(@_);
	107	}
	108
7efea54c	109	sub special_targets {
	110	my $self = shift;
	111	my $targets = $self->SUPER::special_targets(@_);
f57289e3	112	my $phony_targets = join ' ', qw(
f57289e3	113	preflight
7b418de8	114	check-version
5baee32c	115	check-manifest
b0780d0a	116	check-cpan-upload
f57289e3	117	releasetest
	118	release
	119	readmefile
	120	distmanicheck
	121	nextrelease
	122	refresh
	123	bump
	124	bumpmajor
	125	bumpminor
	126	);
	127	$targets =~ s/^(\.PHONY :.)/$1 $phony_targets/m;
7efea54c	128	$targets;
	129	}
	130
ca3b3b8a	131	sub dist_test {
ca3b3b8a	132	my $self = shift;
8ab5ea70	133
66a2ecde	134	my $include = '';
	135	if (open my $fh, '<', 'maint/Makefile.include') {
	136	$include = "\n# --- Makefile.include:\n\n" . do { local $/; <$fh> };
	137	$include =~ s/\n?\z/\n/;
	138	}
b0401762	139
66a2ecde	140	my @bump_targets =
66a2ecde	141	grep { $include !~ /^bump$_(?: +\w+)*:/m } ('', 'minor', 'major');
81d518f6	142
8aac77fc	143	my $distar = File::Spec->catdir(
	144	File::Spec->catpath((File::Spec->splitpath(__FILE__))[0,1], ''),
	145	File::Spec->updir,
	146	);
	147	my $helpers = File::Spec->catdir($distar, 'helpers');
	148
66a2ecde	149	my %vars = (
8aac77fc	150	DISTAR => $self->quote_literal($distar),
8aac77fc	151	HELPERS => $self->quote_literal($helpers),
2c75254f	152	REMAKE => join(' ', '$(PERLRUN)', '-I$(DISTAR)/lib', '-mDistar', 'Makefile.PL', map { $self->quote_literal($_) } @ARGV),
190976f8	153	BRANCH => $self->{BRANCH} \|\|= 'master',
9b920c5c	154	CHANGELOG => $self->{CHANGELOG} \|\|= 'Changes',
b0780d0a	155	DEV_NULL_STDOUT => ($self->{DEV_NULL} ? '>'.File::Spec->devnull : ''),
263b723e	156	FAKE_RELEASE => '',
66a2ecde	157	);
	158
	159	join('',
	160	$self->SUPER::dist_test(@_),
	161	"\n\n# --- Distar section:\n\n",
	162	(map "$_ = $vars{$_}\n", sort keys %vars),
	163	<<'END',
81d518f6	164
b0780d0a	165	preflight: check-version check-manifest check-cpan-upload
8aac77fc	166	$(ABSPERLRUN) $(HELPERS)/preflight $(VERSION) --changelog=$(CHANGELOG) --branch=$(BRANCH)
7b418de8	167	check-version:
8aac77fc	168	$(ABSPERLRUN) $(HELPERS)/check-version $(VERSION) $(TO_INST_PM) $(EXE_FILES)
5baee32c	169	check-manifest:
8aac77fc	170	$(ABSPERLRUN) $(HELPERS)/check-manifest
b0780d0a	171	check-cpan-upload:
b0780d0a	172	$(NOECHO) cpan-upload -h $(DEV_NULL_STDOUT)
3e632431	173	releasetest:
ba5a4b50	174	$(MAKE) disttest RELEASE_TESTING=1 PASTHRU="$(PASTHRU) TEST_FILES=\"$(TEST_FILES)\""
49beea48	175	release: preflight
49beea48	176	$(MAKE) releasetest
42e08a83	177	git commit -a -m "Release commit for $(VERSION)"
401ece0b	178	git tag v$(VERSION) -m "release v$(VERSION)"
49beea48	179	$(RM_RF) $(DISTVNAME)
49beea48	180	$(MAKE) $(DISTVNAME).tar$(SUFFIX)
263b723e	181	$(NOECHO) $(MAKE) pushrelease FAKE_RELEASE=$(FAKE_RELEASE)
	182	pushrelease ::
	183	$(NOECHO) $(NOOP)
	184	pushrelease$(FAKE_RELEASE) ::
65a1f7d9	185	cpan-upload $(DISTVNAME).tar$(SUFFIX)
2c636792	186	git push origin v$(VERSION) HEAD
5154970c	187	distdir: readmefile
75f8311c	188	readmefile: create_distdir
5c5deb0a	189	$(NOECHO) $(TEST_F) $(DISTVNAME)/README \|\| $(MAKE) $(DISTVNAME)/README
f6286f60	190	$(DISTVNAME)/README: $(VERSION_FROM)
	191	$(NOECHO) $(MKPATH) $(DISTVNAME)
	192	pod2text $(VERSION_FROM) >$(DISTVNAME)/README
8aac77fc	193	$(NOECHO) $(ABSPERLRUN) $(HELPERS)/add-to-manifest -d $(DISTVNAME) README
de048fa8	194	disttest: distmanicheck
792c9e91	195	distmanicheck: create_distdir
792c9e91	196	cd $(DISTVNAME) && $(ABSPERLRUN) "-MExtUtils::Manifest=manicheck" -e "exit manicheck"
e7a78651	197	nextrelease:
8aac77fc	198	$(ABSPERLRUN) $(HELPERS)/add-changelog-heading --git $(VERSION) $(CHANGELOG)
0edb27b8	199	refresh:
8aac77fc	200	cd $(DISTAR) && git pull
e9f66489	201	$(RM_F) $(FIRST_MAKEFILE)
0edb27b8	202	$(REMAKE)
8ab5ea70	203	END
66a2ecde	204	map(sprintf(<<'END', "bump$_", ($_ \|\| '$(V)')), @bump_targets),
66a2ecde	205	%s:
8aac77fc	206	$(ABSPERLRUN) $(HELPERS)/bump-version --git $(VERSION) %s
66a2ecde	207	$(RM_F) $(FIRST_MAKEFILE)
66a2ecde	208	$(REMAKE)
42e08a83	209	END
66a2ecde	210	$include,
	211	"\n",
	212	);
42e08a83	213	}
	214	}
	215
42e08a83	216	1;
edb4539a	217	__END__
	218
	219	=head1 NAME
	220
	221	Distar - Additions to ExtUtils::MakeMaker for dist authors
	222
	223	=head1 SYNOPSIS
	224
	225	F<Makefile.PL>:
	226
	227	use ExtUtils::MakeMaker;
	228	(do 'maint/Makefile.PL.include' or die $@) unless -f 'META.yml';
	229
	230	WriteMakefile(...);
	231
	232	F<maint/Makefile.PL.include>:
	233
	234	BEGIN { -e 'Distar' or system("git clone git://git.shadowcat.co.uk/p5sagit/Distar.git") }
	235	use lib 'Distar/lib';
	236	use Distar 0.001;
	237
	238	author 'A. U. Thor <author@cpan.org>';
	239
	240	manifest_include t => 'test-helper.pl';
	241	manifest_include corpus => '.txt';
	242
	243	make commmands:
	244
	245	$ perl Makefile.PL
	246	$ make bump # bump version
	247	$ make bump V=2.000000 # bump to specific version
	248	$ make bumpminor # bump minor version component
	249	$ make bumpmajor # bump major version component
	250	$ make nextrelease # add version heading to Changes file
	251	$ make releasetest # build dist and test (with xt/ and RELEASE_TESTING=1)
	252	$ make preflight # check that repo and file state is release ready
	253	$ make release # check releasetest and preflight, then build and
	254	# upload to CPAN, tag release, push tag and branch
	255
	256	=head1 DESCRIPTION
	257
	258	L<ExtUtils::MakeMaker> works well enough as development tool for
	259	builting and testing, but using it to release is annoying and error prone.
	260	Distar adds just enough to L<ExtUtils::MakeMaker> for it to be a usable dist
	261	author tool. This includes extra commands for releasing and safety checks, and
	262	automatic generation of some files. It doesn't require any non-core modules and
	263	is compatible with old versions of perl.
	264
	265	=head1 FUNCTIONS
	266
	267	=head2 author( $author )
	268
	269	Set the author to include in generated META files. Can be a single entry, or
	270	an arrayref.
	271
	272	=head2 manifest_include( $dir, $pattern )
	273
	274	Add a pattern to include files in the MANIFEST file, and thus in the generated
	275	dist files.
	276
	277	The pattern can be either a regex, or a path suffix. It will be applied to the
	278	full path past the directory specified.
	279
	280	The default files that are always included are: F<.pm> and F<.pod> files in
281	F<lib>, F<.t> files in F<t> and F<xt>, F<.pm> files in F<t/lib> and F<xt/lib>,
282	F<Changes>, F<MANIFEST>, F<README>, F<LICENSE>, F<META.yml>, and F<.PL> files in
283	the dist root, and all files in F<maint>.
284
285	=head1 AUTOGENERATED FILES
286
287	=over 4
288
289	=item F<MANIFEST.SKIP>
290
291	The F<MANIFEST.SKIP> will be automatically generated to exclude any files not
292	explicitly allowed via C<manifest_include> or the included defaults. It will be
293	created (or updated) at C<perl Makefile.PL> time.
294
295	=item F<README>
296
297	The F<README> file will be generated at dist generation time, inside the built
298	dist. It will be generated using C<pod2text> on the main module.
299
300	If a F<README> file exists in the repo, it will be used directly instead of
301	generating the file.
302
303	=back
304
305	=head1 MAKE COMMMANDS
306
307	=head2 test
308
309	test will be adjusted to include F<xt/> tests by default. This will only apply
310	for authors, not users installing from CPAN.
311
312	=head2 release
313
314	Releases the dist. Before releasing, checks will be done on the dist using the
315	C<preflight> and C<releasetest> commands.
316
317	Releasing will generate a dist tarball and upload it to CPAN using cpan-upload.
318	It will also create a git tag for the release, and push the tag and branch.
319
263b723e	320	=head2 FAKE_RELEASE
	321
	322	If release is run with FAKE_RELEASE=1 set, it will skip uploading to CPAN and
	323	pushing to git. A release commit will still be created and tagged locally.
	324
edb4539a	325	=head2 preflight
	326
	327	Performs a number of checks on the files and repository, ensuring it is in a
	328	sane state to do a release. The checks are:
	329
	330	=over 4
	331
	332	=item * All version numbers match
	333
	334	=item * The F<MANIFEST> file is up to date
	335
	336	=item * The branch is correct
	337
	338	=item * There is no existing tag for the version
	339
	340	=item * There are no unmerged upstream changes
	341
	342	=item * There are no outstanding local changes
	343
	344	=item * There is an appropriate staged Changes heading
	345
	346	=item * cpan-upload is available
	347
	348	=back
	349
	350	=head2 releasetest
	351
	352	Test the dist preparing for a release. This generates a dist dir and runs the
	353	tests from inside it. This ensures all appropriate files are included inside
	354	the dist. C<RELEASE_TESTING> will be set in the environment.
	355
	356	=head2 nextrelease
	357
	358	Adds an appropriate changelog heading for the release, and prompts to stage the
	359	change.
	360
	361	=head2 bump
	362
	363	Bumps the version number. This will try to preserve the length and format of
	364	the version number. The least significant digit will be incremented.
	365
	366	Optionally accepts a C<V> option to set the version to a specific value.
	367
	368	The version changes will automatically be committed. Unstaged modifications to
	369	the files will be left untouched.
	370
	371	=head2 bumpminor
	372
	373	Like bump, but increments the minor segment of the version. This will treat
	374	numeric versions as x.yyyzzz format, incrementing the yyy segment.
	375
	376	=head2 bumpmajor
	377
	378	Like bumpminor, but bumping the major segment.
	379
	380	=head2 refresh
	381
	382	Updates Distar and re-runs C<perl Makefile.PL>
	383
	384	=head1 SUPPORT
	385
	386	IRC: #web-simple on irc.perl.org
	387
	388	Git repository: L<git://git.shadowcat.co.uk/p5sagit/Distar>
389
390	Git browser: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit/Distar.git;a=summary>
391
392	=head1 AUTHOR
393
394	mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
395
396	=head1 CONTRIBUTORS
397
398	haarg - Graham Knop (cpan:HAARG) <haarg@cpan.org>
399
400	ether = Karen Etheridge (cpan:ETHER) <ether@cpan.org>
401
402	frew - Arthur Axel "fREW" Schmidt (cpan:FREW) <frioux@gmail.com>
403
404	Mithaldu - Christian Walde (cpan:MITHALDU) <walde.christian@googlemail.com>
405
406	=head1 COPYRIGHT
407
408	Copyright (c) 2011-2015 the Distar L</AUTHOR> and L</CONTRIBUTORS>
409	as listed above.
410
411	=head1 LICENSE
412
413	This library is free software and may be distributed under the same terms
414	as perl itself. See L<http://dev.perl.org/licenses/>.
415
416	=cut