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

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

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) = @_;
    return $class->SUPER::new({
      LICENSE => 'perl_5',
      MIN_PERL_VERSION => '5.006',
      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}||'')
        . ' Distar/ MANIFEST.SKIP MANIFEST MANIFEST.bak'
      ) },
    });
  }

  sub flush {
    my $self = shift;
    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
      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 %vars = (
      REMAKE => join(' ', '$(PERLRUN)', 'Makefile.PL', map { $self->quote_literal($_) } @ARGV),
      BRANCH => $self->{BRANCH} ||= 'master',
      CHANGELOG => $self->{CHANGELOG} ||= 'Changes',
    );

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

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