X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDistar.pm;h=68233b31a02ac1d3e687f68aee018c04dc198c11;hb=f0bbeff7a84f54c39cb0025d134f75c5169fb671;hp=34e1e319cb7d1080aaba16904ce2fb7078023df3;hpb=65a1f7d91be734caa9ad72723c30845fbd39c37f;p=p5sagit%2FDistar.git diff --git a/lib/Distar.pm b/lib/Distar.pm index 34e1e31..68233b3 100644 --- a/lib/Distar.pm +++ b/lib/Distar.pm @@ -1,32 +1,41 @@ package Distar; - -use strictures 1; +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; -use Config; -use File::Spec; +my $MM_VER = eval $ExtUtils::MakeMaker::VERSION; our @EXPORT = qw( - author manifest_include run_preflight + author manifest_include readme_generator ); sub import { - strictures->import; + strict->import; + warnings->import(FATAL => 'all'); shift->export_to_level(1,@_); } -sub author { our $Author = shift } - -our $Ran_Preflight; +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|META\.yml}, + '' => qr{Changes|MANIFEST|README|LICENSE|META\.yml}, 'maint' => qr{[^.].*}, ); @@ -34,8 +43,12 @@ sub manifest_include { push @Manifest, @_; } +sub readme_generator { + die "readme_generator unsupported" if @_ && $_[0]; +} + sub write_manifest_skip { - use autodie; + my ($mm) = @_; my @files = @Manifest; my @parts; while (my ($dir, $spec) = splice(@files, 0, 2)) { @@ -48,80 +61,392 @@ sub write_manifest_skip { : die "spec must be string or regexp, was: ${spec} (${\ref $spec})"); push @parts, $re; } - my $final = '^(?!'.join('|', map "${_}\$", @parts).')'; - open my $skip, '>', 'MANIFEST.SKIP'; + 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 { - $Ran_Preflight = 1; +{ + package Distar::MM; + our @ISA = @MM::ISA; + @MM::ISA = (__PACKAGE__); - system("git fetch"); + 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' + ) }, + }); + } - my $make = $Config{make}; - my $null = File::Spec->devnull; + sub flush { + my $self = shift; + `git ls-files --error-unmatch MANIFEST.SKIP 2>&1`; + my $maniskip_tracked = !$?; - for (scalar `"$make" manifest 2>&1 >$null`) { - $_ && die "$make manifest changed:\n$_ Go check it and retry"; + Distar::write_manifest_skip($self) + unless $maniskip_tracked; + $self->SUPER::flush(@_); } - 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"; + 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; } - for (scalar `git diff`) { - length && die "Outstanding changes"; - } - my $ymd = sprintf( - "%i-%02i-%02i", (localtime)[5]+1900, (localtime)[4]+1, (localtime)[3] - ); - my @cached = grep /^\+/, `git diff --cached -U0`; - @cached > 0 or die "Please add:\n\n$ARGV[0] - $ymd\n\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 "+$ARGV[0] - $ymd\n" or die "Changes new line should be: \n\n$ARGV[0] - $ymd\n "; -} + 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/; + } -sub MY::postamble { - my $post = <<'END'; -preflight: - perl -IDistar/lib -MDistar -erun_preflight $(VERSION) + 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 => '', + DISTTEST_MAKEFILE_PARAMS => '', + ); + + 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) disttest - rm -rf $(DISTVNAME) - $(MAKE) $(DISTVNAME).tar$(SUFFIX) + $(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 --tags origin - git push origin HEAD + 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) cd $(DISTVNAME) && $(ABSPERLRUN) ../Distar/helpers/add-readme-to-manifest + $(NOECHO) $(ABSPERLRUN) $(HELPERS)/add-to-manifest -d $(DISTVNAME) README +distsignature: readmefile +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 || $(TRUE) + $(RM_F) $(FIRST_MAKEFILE) + $(REMAKE) END - if (open my $fh, '<', 'maint/Makefile.include') { - $post .= do { local $/; <$fh> }; - } - return $post; -} - -{ - no warnings 'redefine'; - sub main::WriteMakefile { - my %args = @_; - ExtUtils::MakeMaker::WriteMakefile( - LICENSE => 'perl', - @_, AUTHOR => our $Author, ABSTRACT_FROM => $args{VERSION_FROM}, - test => { TESTS => ($args{test}{TESTS}||'t/*.t').' xt/*.t' }, + map(sprintf(<<'END', "bump$_", ($_ || '$(V)')), @bump_targets), +%s: + $(ABSPERLRUN) $(HELPERS)/bump-version --git $(VERSION) %s + $(RM_F) $(FIRST_MAKEFILE) + $(REMAKE) +END + $include, + "\n", ); } } -END { - write_manifest_skip() unless $Ran_Preflight -} - 1; +__END__ + +=head1 NAME + +Distar - Additions to ExtUtils::MakeMaker for dist authors + +=head1 SYNOPSIS + +F: + + use ExtUtils::MakeMaker; + (do './maint/Makefile.PL.include' or die $@) unless -f 'META.yml'; + + WriteMakefile(...); + +F: + + 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 '; + + 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 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 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, F<.t> files in F and F, F<.pm> files in F and F, +F, F, F, F, F, and F<.PL> files in +the dist root, and all files in F. + +=head1 AUTOGENERATED FILES + +=over 4 + +=item F + +The F will be automatically generated to exclude any files not +explicitly allowed via C or the included defaults. It will be +created (or updated) at C time. + +=item F + +The F file will be generated at dist generation time, inside the built +dist. It will be generated using C on the main module. + +If a F 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 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 and C 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 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 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 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 + +=head1 SUPPORT + +IRC: #web-simple on irc.perl.org + +Git repository: L + +Git browser: L + +=head1 AUTHOR + +mst - Matt S. Trout (cpan:MSTROUT) + +=head1 CONTRIBUTORS + +haarg - Graham Knop (cpan:HAARG) + +ether - Karen Etheridge (cpan:ETHER) + +frew - Arthur Axel "fREW" Schmidt (cpan:FREW) + +Mithaldu - Christian Walde (cpan:MITHALDU) + +=head1 COPYRIGHT + +Copyright (c) 2011-2015 the Distar L and L +as listed above. + +=head1 LICENSE + +This library is free software and may be distributed under the same terms +as perl itself. See L. + +=cut