X-Git-Url: https://git.exim.org/users/jgh/exim.git/blobdiff_plain/8a483da652e021e51ee3f4dd83cd34e53c986b35..43236f357ba2001d59b5937d14a50a56478bb8e0:/release-process/scripts/mk_exim_release.pl diff --git a/release-process/scripts/mk_exim_release.pl b/release-process/scripts/mk_exim_release.pl index dd30f2768..566f2619d 100755 --- a/release-process/scripts/mk_exim_release.pl +++ b/release-process/scripts/mk_exim_release.pl @@ -1,4 +1,4 @@ -#!/usr/bin/perl +#!/usr/bin/env perl # # $Cambridge: exim/release-process/scripts/mk_exim_release.pl,v 1.1 2010/06/03 12:00:38 nm4 Exp $ # @@ -8,7 +8,10 @@ use Carp; use File::Copy; use File::Spec; use File::Path; +use File::Temp; +use FindBin; use Getopt::Long; +use IO::File; use Pod::Usage; my $debug = 0; @@ -18,18 +21,24 @@ my $verbose = 0; sub get_and_check_version { my $release = shift; + my $context = shift; # make sure this looks like a real release version - # which should (currently) be 4.xx + # which should (currently) be 4.xx or 4.xx_RCx unless ( $release =~ /^(4\.\d\d(?:_RC\d+)?)$/ ) { croak "The given version number does not look right - $release"; } - return $1; # untainted here... + my $full_release = $1; # untainted here... + my $trunc_release = $full_release; + $trunc_release =~ s/^(4\.\d\d)(?:_RC\d+)?$/$1/; + + $context->{release} = $full_release; + $context->{trelease} = $trunc_release; } # ------------------------------------------------------------------ -sub build_cvs_tag { +sub build_tag { my $context = shift; # The CVS tag consists of exim-$version where $version @@ -61,27 +70,152 @@ sub deal_with_working_directory { } } + # create base directory mkpath( $context->{directory}, { verbose => ( $verbose || $debug ) } ); + + # set and create subdirectories + foreach (qw(release_tree pkgs pkgdirs docbook)) { + $context->{$_} = File::Spec->catdir( $context->{directory}, $_ ); + mkpath( $context->{$_}, { verbose => ( $verbose || $debug ) } ); + } } # ------------------------------------------------------------------ -sub export_cvs_tree { +sub export_git_tree { my $context = shift; - # build CVS command - my @cmd = ( 'cvs', '-d', $context->{cvsroot}, '-Q', 'export', '-r', $context->{tag}, $context->{pkgname}, ); + # build git command + my $archive_file = sprintf( '%s/%s-%s.tar', $context->{tmp_dir}, $context->{pkgname}, $context->{release} ); + $context->{tmp_archive_file} = $archive_file; + my @cmd = ( 'git', 'archive', '--format=tar', "--output=$archive_file", $context->{tag} ); - # run cvs command + # run git command print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose); system(@cmd) == 0 || croak "Export failed"; } # ------------------------------------------------------------------ +sub unpack_tree { + my $context = shift; + + die "Cannot see archive file\n" unless ( -f $context->{tmp_archive_file} ); + my @cmd = ( 'tar', 'xf', $context->{tmp_archive_file}, '-C', $context->{release_tree} ); + + # run command + print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose); + system(@cmd) == 0 || croak "Unpack failed"; +} + +# ------------------------------------------------------------------ + +sub adjust_version_extension { + my $context = shift; + + return if ($context->{release} eq $context->{trelease}); + + my $variant = substr( $context->{release}, length($context->{trelease}) ); + if ( $context->{release} ne $context->{trelease} . $variant ) { + die "Broken version numbering, I'm buggy"; + } + + my $srcdir = File::Spec->catdir( $context->{release_tree}, 'src', 'src' ); + my $version_h = File::Spec->catfile( $srcdir, 'version.h' ); + + my $fh = new IO::File $version_h, 'r'; + die "Cannot read version.h: $!\n" unless ( defined $fh ); + my @lines = <$fh>; + $fh->close() or die "Failed to close-read($version_h): $!\n"; + + my $found = 0; + my $i; + for ( $i = 0 ; $i < @lines ; ++$i ) { + if ( $lines[$i] =~ /EXIM_VARIANT_VERSION/ ) { + $found = 1; + last; + } + } + die "Cannot find version.h EXIM_VARIANT_VERSION\n" unless $found; + unless ( $lines[$i] =~ m/^\s* \# \s* define \s+ EXIM_VARIANT_VERSION \s+ "(.*)" \s* $/x ) { + die "Broken version.h EXIM_VARIANT_VERSION line\n"; + } + if ( length $1 ) { + print( "WARNING: version.h has a variant tag already defined: $1\n" ); + print( " not changing that tag\n" ); + return; + } + + $lines[$i] = qq{#define EXIM_VARIANT_VERSION\t\t"$variant"\n}; + # deliberately not verbose constrained: + print( "Adjusting version.h for $variant release.\n" ); + + $fh = new IO::File $version_h, "w"; + die "Cannot write version.h: $!\n" unless ( defined $fh ); + $fh->print( @lines ); + $fh->close() or die "Failed to close-write($version_h): $!\n"; +} + +# ------------------------------------------------------------------ + +sub build_html_documentation { + my $context = shift; + + my $genpath = $context->{webgen_base} . '/script/gen.pl'; + my $templates = $context->{webgen_base} . '/templates'; + my $dir = File::Spec->catdir( $context->{release_tree}, 'html' ); + my $spec = File::Spec->catfile( $context->{docbook}, 'spec.xml' ); + my $filter = File::Spec->catfile( $context->{docbook}, 'filter.xml' ); + + mkdir($dir); + + my @cmd = + ( $genpath, '--spec', $spec, '--filter', $filter, '--latest', $context->{trelease}, '--tmpl', $templates, '--docroot', $dir ); + + print "Executing ", join( ' ', @cmd ), "\n"; + system(@cmd); + + # move directory into right place + my $sourcedir = File::Spec->catdir( $context->{docbook}, 'filter.xml' ); + + rename( + File::Spec->catdir( $dir, sprintf( 'exim-html-%s', $context->{trelease} ) ), + File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-html-%s', $context->{release} ) ) + ); +} + +# ------------------------------------------------------------------ + +sub copy_docbook_files { + my $context = shift; + + # where the generated docbook files can be found + my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' ); + + # where the website docbook source dir is - push files to here + my $webdir = File::Spec->catdir( $context->{webgen_base}, 'docbook', $context->{trelease} ); + mkpath( $webdir, { verbose => ( $verbose || $debug ) } ); + + foreach my $file ( 'spec.xml', 'filter.xml' ) { + my $from = File::Spec->catfile( $docdir, $file ); + my $to = File::Spec->catfile( $context->{docbook}, $file ); + my $webto = File::Spec->catfile( $webdir, $file ); + copy( $from, $to ); + copy( $from, $webto ); + } +} + +# ------------------------------------------------------------------ + sub build_documentation { - system("cd exim/exim-doc/doc-docbook && ./OS-Fixups && make everything") == 0 + my $context = shift; + + my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' ); + system("cd '$docdir' && ./OS-Fixups && make everything") == 0 || croak "Doc build failed"; + + copy_docbook_files($context); + build_html_documentation($context); } # ------------------------------------------------------------------ @@ -89,8 +223,9 @@ sub build_documentation { sub move_text_docs_into_pkg { my $context = shift; - my $old_docdir = 'exim/exim-doc/doc-docbook'; - my $new_docdir = File::Spec->catdir( $context->{pkgdir}, 'doc' ); + my $old_docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' ); + my $old_txtdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-txt' ); + my $new_docdir = File::Spec->catdir( $context->{eximpkgdir}, 'doc' ); mkpath( $new_docdir, { verbose => ( $verbose || $debug ) } ); # move generated documents from docbook stuff @@ -99,7 +234,7 @@ sub move_text_docs_into_pkg { } # move text documents across - foreach my $file ( glob( File::Spec->catfile( 'exim/exim-doc/doc-txt', '*' ) ) ) { + foreach my $file ( glob( File::Spec->catfile( $old_txtdir, '*' ) ) ) { # skip a few we dont want my $fn = ( File::Spec->splitpath($file) )[2]; @@ -118,15 +253,16 @@ sub build_pspdfinfo_directory { ##foreach my $format (qw/pdf postscript texinfo info/) { foreach my $format (qw/pdf postscript/) { - my $dir = sprintf( 'exim-%s-%s', $format, $context->{release} ); - my $target = File::Spec->catdir( $dir, 'doc' ); + my $target = File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-%s-%s', $format, $context->{release} ), 'doc' ); mkpath( $target, { verbose => ( $verbose || $debug ) } ); # move documents across foreach my $file ( glob( File::Spec->catfile( - 'exim/exim-doc/doc-docbook', + $context->{release_tree}, + 'doc', + 'doc-docbook', ( ( $format eq 'postscript' ) ? '*.ps' @@ -136,42 +272,25 @@ sub build_pspdfinfo_directory { ) ) { - my $fn = ( File::Spec->splitpath($file) )[2]; - move( $file, File::Spec->catfile( $target, $fn ) ); + move( $file, File::Spec->catfile( $target, ( File::Spec->splitpath($file) )[2] ) ); } } } # ------------------------------------------------------------------ -sub build_html_directory { - my $context = shift; - - my $dir = sprintf( 'exim-%s-%s', 'html', $context->{release} ); - my $target = File::Spec->catdir( $dir, 'doc', 'html' ); - mkpath( $target, { verbose => ( $verbose || $debug ) } ); - - # move documents across - move( File::Spec->catdir( 'exim/exim-doc/doc-docbook', 'spec_html' ), File::Spec->catdir( $target, 'spec_html' ) ); - foreach my $file ( glob( File::Spec->catfile( 'exim/exim-doc/doc-docbook', '*.html' ) ) ) { - my $fn = ( File::Spec->splitpath($file) )[2]; - move( $file, File::Spec->catfile( $target, $fn ) ); - } -} - -# ------------------------------------------------------------------ - sub build_main_package_directory { my $context = shift; + # build the exim package directory path + $context->{eximpkgdir} = File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-%s', $context->{release} ) ); + # initially we move the exim-src directory to the new directory name - my $pkgdir = sprintf( 'exim-%s', $context->{release} ); - $context->{pkgdir} = $pkgdir; - rename( 'exim/exim-src', $pkgdir ) || croak "Rename of src dir failed - $!"; + rename( File::Spec->catdir( $context->{release_tree}, 'src' ), $context->{eximpkgdir} ) + || croak "Rename of src dir failed - $!"; # add Local subdirectory - my $target = File::Spec->catdir( $pkgdir, 'Local' ); - mkpath( $target, { verbose => ( $verbose || $debug ) } ); + mkpath( File::Spec->catdir( $context->{eximpkgdir}, 'Local' ), { verbose => ( $verbose || $debug ) } ); # now add the text docs move_text_docs_into_pkg($context); @@ -184,7 +303,17 @@ sub build_package_directories { build_main_package_directory($context); build_pspdfinfo_directory($context); - build_html_directory($context); +} + +# ------------------------------------------------------------------ + +sub do_cleanup { + my $context = shift; + + print "Cleaning up\n" if ($verbose); + rmtree( $context->{release_tree}, { verbose => $debug } ); + rmtree( $context->{docbook}, { verbose => $debug } ); + rmtree( $context->{pkgdirs}, { verbose => $debug } ); } # ------------------------------------------------------------------ @@ -192,9 +321,12 @@ sub build_package_directories { sub create_tar_files { my $context = shift; - foreach my $dir ( glob( 'exim*-' . $context->{release} ) ) { - system("tar cfz ${dir}.tar.gz ${dir}"); - system("tar cfj ${dir}.tar.bz2 ${dir}"); + my $pkgs = $context->{pkgs}; + my $pkgdirs = $context->{pkgdirs}; + foreach my $dir ( glob( File::Spec->catdir( $pkgdirs, ( 'exim*-' . $context->{release} ) ) ) ) { + my $dirname = ( File::Spec->splitdir($dir) )[-1]; + system("tar cfz ${pkgs}/${dirname}.tar.gz -C ${pkgdirs} ${dirname}"); + system("tar cfj ${pkgs}/${dirname}.tar.bz2 -C ${pkgdirs} ${dirname}"); } } @@ -203,22 +335,25 @@ sub create_tar_files { my $man; my $help; my $context = { - cvsroot => ':ext:nm4@vcs.exim.org:/home/cvs', - pkgname => 'exim', - orig_dir => File::Spec->curdir(), + pkgname => 'exim', + orig_dir => File::Spec->curdir(), + tmp_dir => File::Temp->newdir(), + webgen_base => "$FindBin::Bin/../../../exim-website", }; my $delete; - $ENV{'PATH'} = '/opt/local/bin:' . $ENV{'PATH'}; + my $cleanup = 1; + ##$ENV{'PATH'} = '/opt/local/bin:' . $ENV{'PATH'}; unless ( GetOptions( - 'directory=s' => \$context->{directory}, - 'cvsroot=s' => \$context->{cvsroot}, - 'verbose!' => \$verbose, - 'debug!' => \$debug, - 'help|?' => \$help, - 'man!' => \$man, - 'delete!' => \$delete, + 'directory=s' => \$context->{directory}, + 'webgen_base=s' => \$context->{webgen_base}, + 'verbose!' => \$verbose, + 'debug!' => \$debug, + 'help|?' => \$help, + 'man!' => \$man, + 'delete!' => \$delete, + 'cleanup!' => \$cleanup, ) ) { @@ -227,14 +362,17 @@ sub create_tar_files { pod2usage(0) if $help; pod2usage( -verbose => 2 ) if $man; - $context->{release} = get_and_check_version(shift); - $context->{tag} = build_cvs_tag($context); + get_and_check_version( shift, $context ); + $context->{tag} = build_tag($context); deal_with_working_directory( $context, $delete ); + export_git_tree($context); chdir( $context->{directory} ) || die; - export_cvs_tree($context); + unpack_tree($context); + adjust_version_extension($context); build_documentation($context); build_package_directories($context); create_tar_files($context); + do_cleanup($context) if ($cleanup); } 1; @@ -255,7 +393,6 @@ mk_exim_release.pl [options] version --help display this help and exits --man displays man page --directory=dir dir to package - --cvsroot=s CVS root spec --delete Delete packaging directory at start =head1 OPTIONS @@ -285,11 +422,8 @@ Display man page Builds an exim release. -Starting in an empty directory, with the CVS repo already tagged -for release, build docs, build packages etc. - -NB The CVS root spec is embedded in the script or can be given via -the I<--cvsroot> parameter +Starting in a populated git repo that has already been tagged for +release, build docs, build packages etc. Parameter is the version number to build as - ie 4.72 4.72RC1 etc @@ -299,6 +433,6 @@ Nigel Metheringham =head1 COPYRIGHT -Copyright 2009 Someone. All rights reserved. +Copyright 2010 Exim Maintainers. All rights reserved. =cut