Merge branch 'master' of git://git.exim.org/exim
[exim.git] / release-process / scripts / mk_exim_release.pl
CommitLineData
46c573de 1#!/usr/bin/env perl
3634fc25 2
8a483da6
NM
3use strict;
4use warnings;
5use Carp;
6use File::Copy;
7use File::Spec;
8use File::Path;
8f29c950 9use File::Temp;
be914e6c 10use FindBin;
8a483da6 11use Getopt::Long;
ba41f854 12use IO::File;
8a483da6
NM
13use Pod::Usage;
14
15my $debug = 0;
16my $verbose = 0;
17
18# ------------------------------------------------------------------
19
20sub get_and_check_version {
21 my $release = shift;
be914e6c 22 my $context = shift;
8a483da6
NM
23
24 # make sure this looks like a real release version
8f29c950 25 # which should (currently) be 4.xx or 4.xx_RCx
8a483da6
NM
26 unless ( $release =~ /^(4\.\d\d(?:_RC\d+)?)$/ ) {
27 croak "The given version number does not look right - $release";
28 }
be914e6c
NM
29 my $full_release = $1; # untainted here...
30 my $trunc_release = $full_release;
31 $trunc_release =~ s/^(4\.\d\d)(?:_RC\d+)?$/$1/;
32
33 $context->{release} = $full_release;
34 $context->{trelease} = $trunc_release;
8a483da6
NM
35}
36
37# ------------------------------------------------------------------
38
8f29c950 39sub build_tag {
8a483da6
NM
40 my $context = shift;
41
42 # The CVS tag consists of exim-$version where $version
43 # is the version number with . replaced with _
44 my $modversion = $context->{release};
45 $modversion =~ tr/0-9RC/_/cs;
46
47 return sprintf( 'exim-%s', $modversion );
48}
49
50# ------------------------------------------------------------------
51
52sub deal_with_working_directory {
53 my $context = shift;
54 my $delete = shift;
55
56 # Set default directory
57 $context->{directory} ||= File::Spec->rel2abs( sprintf( 'exim-packaging-%s', $context->{release} ) );
58 my $directory = $context->{directory};
59
60 # ensure the working directory is not in place
61 if ( -d $directory ) {
62 if ($delete) {
63 print "Deleting existing $directory\n" if ($verbose);
64 rmtree( $directory, { verbose => $debug } );
65 }
66 if ( -d $directory ) {
67 croak "Working directory $directory exists";
68 }
69 }
70
46c573de 71 # create base directory
8a483da6 72 mkpath( $context->{directory}, { verbose => ( $verbose || $debug ) } );
46c573de
NM
73
74 # set and create subdirectories
5901f0ab 75 foreach (qw(release_tree pkgs pkgdirs docbook tmp)) {
46c573de
NM
76 $context->{$_} = File::Spec->catdir( $context->{directory}, $_ );
77 mkpath( $context->{$_}, { verbose => ( $verbose || $debug ) } );
78 }
8a483da6
NM
79}
80
81# ------------------------------------------------------------------
82
8f29c950 83sub export_git_tree {
8a483da6
NM
84 my $context = shift;
85
8f29c950 86 # build git command
5901f0ab 87 my $archive_file = sprintf( '%s/%s-%s.tar', $context->{tmp}, $context->{pkgname}, $context->{release} );
8f29c950
NM
88 $context->{tmp_archive_file} = $archive_file;
89 my @cmd = ( 'git', 'archive', '--format=tar', "--output=$archive_file", $context->{tag} );
8a483da6 90
8f29c950 91 # run git command
8a483da6
NM
92 print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
93 system(@cmd) == 0 || croak "Export failed";
94}
95
96# ------------------------------------------------------------------
97
8f29c950
NM
98sub unpack_tree {
99 my $context = shift;
100
101 die "Cannot see archive file\n" unless ( -f $context->{tmp_archive_file} );
46c573de 102 my @cmd = ( 'tar', 'xf', $context->{tmp_archive_file}, '-C', $context->{release_tree} );
8f29c950
NM
103
104 # run command
105 print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
106 system(@cmd) == 0 || croak "Unpack failed";
107}
108
109# ------------------------------------------------------------------
110
5901f0ab 111sub make_version_script {
ba41f854
PP
112 my $context = shift;
113
ba41f854
PP
114 my $variant = substr( $context->{release}, length($context->{trelease}) );
115 if ( $context->{release} ne $context->{trelease} . $variant ) {
116 die "Broken version numbering, I'm buggy";
117 }
5901f0ab 118
ba41f854 119 my $srcdir = File::Spec->catdir( $context->{release_tree}, 'src', 'src' );
5901f0ab
TF
120 chdir $srcdir or die "chdir $srcdir: $\n";
121
122 if ( -f "version.sh" ) {
123 print( "WARNING: version.sh already exists - leaving it in place\n" );
ba41f854
PP
124 return;
125 }
126
5901f0ab
TF
127 my @cmd = ("../scripts/reversion", "release");
128 print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
129 system(@cmd) == 0 || croak "reversion failed";
130
131 unlink "version.h";
ba41f854 132
5901f0ab 133 -f "version.sh" or die "failed to create version.h";
ba41f854
PP
134}
135
136# ------------------------------------------------------------------
137
be914e6c
NM
138sub build_html_documentation {
139 my $context = shift;
140
141 my $genpath = $context->{webgen_base} . '/script/gen.pl';
142 my $templates = $context->{webgen_base} . '/templates';
46c573de
NM
143 my $dir = File::Spec->catdir( $context->{release_tree}, 'html' );
144 my $spec = File::Spec->catfile( $context->{docbook}, 'spec.xml' );
145 my $filter = File::Spec->catfile( $context->{docbook}, 'filter.xml' );
146
be914e6c
NM
147 mkdir($dir);
148
cd6d74ab
NM
149 my @cmd = (
150 $genpath, '--spec', $spec, '--filter',
151 $filter, '--latest', $context->{trelease}, '--tmpl',
f9f67570
TL
152 $templates, '--docroot', $dir, '--localstatic',
153 (($verbose||$debug) ? '--verbose' : '')
cd6d74ab 154 );
be914e6c
NM
155
156 print "Executing ", join( ' ', @cmd ), "\n";
157 system(@cmd);
158
159 # move directory into right place
46c573de
NM
160 my $sourcedir = File::Spec->catdir( $context->{docbook}, 'filter.xml' );
161
162 rename(
163 File::Spec->catdir( $dir, sprintf( 'exim-html-%s', $context->{trelease} ) ),
164 File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-html-%s', $context->{release} ) )
165 );
166}
167
168# ------------------------------------------------------------------
169
170sub copy_docbook_files {
171 my $context = shift;
172
173 # where the generated docbook files can be found
174 my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
175
176 # where the website docbook source dir is - push files to here
177 my $webdir = File::Spec->catdir( $context->{webgen_base}, 'docbook', $context->{trelease} );
178 mkpath( $webdir, { verbose => ( $verbose || $debug ) } );
179
180 foreach my $file ( 'spec.xml', 'filter.xml' ) {
181 my $from = File::Spec->catfile( $docdir, $file );
182 my $to = File::Spec->catfile( $context->{docbook}, $file );
183 my $webto = File::Spec->catfile( $webdir, $file );
184 copy( $from, $to );
185 copy( $from, $webto );
186 }
be914e6c
NM
187}
188
189# ------------------------------------------------------------------
190
8a483da6 191sub build_documentation {
be914e6c
NM
192 my $context = shift;
193
46c573de 194 my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
39d16d73
PP
195 # documentation building gets the truncated release, without RC
196 system("cd '$docdir' && ./OS-Fixups && make EXIM_VER=$context->{trelease} everything") == 0
8a483da6 197 || croak "Doc build failed";
be914e6c 198
46c573de 199 copy_docbook_files($context);
be914e6c 200 build_html_documentation($context);
8a483da6
NM
201}
202
203# ------------------------------------------------------------------
204
205sub move_text_docs_into_pkg {
206 my $context = shift;
207
821bc55f
PP
208 my $old_docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
209 my $old_txtdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-txt' );
46c573de 210 my $new_docdir = File::Spec->catdir( $context->{eximpkgdir}, 'doc' );
8a483da6
NM
211 mkpath( $new_docdir, { verbose => ( $verbose || $debug ) } );
212
213 # move generated documents from docbook stuff
214 foreach my $file (qw/exim.8 spec.txt filter.txt/) {
215 move( File::Spec->catfile( $old_docdir, $file ), File::Spec->catfile( $new_docdir, $file ) );
216 }
217
218 # move text documents across
821bc55f 219 foreach my $file ( glob( File::Spec->catfile( $old_txtdir, '*' ) ) ) {
8a483da6
NM
220
221 # skip a few we dont want
222 my $fn = ( File::Spec->splitpath($file) )[2];
223 next
224 if ( ( $fn eq 'ABOUT' )
225 || ( $fn eq 'ChangeLog.0' )
226 || ( $fn eq 'test-harness.txt' ) );
227 move( $file, File::Spec->catfile( $new_docdir, $fn ) );
228 }
229}
230
231# ------------------------------------------------------------------
232
233sub build_pspdfinfo_directory {
234 my $context = shift;
235
236 ##foreach my $format (qw/pdf postscript texinfo info/) {
237 foreach my $format (qw/pdf postscript/) {
46c573de 238 my $target = File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-%s-%s', $format, $context->{release} ), 'doc' );
8a483da6
NM
239 mkpath( $target, { verbose => ( $verbose || $debug ) } );
240
241 # move documents across
242 foreach my $file (
243 glob(
244 File::Spec->catfile(
46c573de
NM
245 $context->{release_tree},
246 'doc',
247 'doc-docbook',
8a483da6
NM
248 (
249 ( $format eq 'postscript' )
250 ? '*.ps'
251 : ( '*.' . $format )
252 )
253 )
254 )
255 )
256 {
46c573de 257 move( $file, File::Spec->catfile( $target, ( File::Spec->splitpath($file) )[2] ) );
8a483da6
NM
258 }
259 }
260}
261
262# ------------------------------------------------------------------
263
8a483da6
NM
264sub build_main_package_directory {
265 my $context = shift;
266
46c573de
NM
267 # build the exim package directory path
268 $context->{eximpkgdir} = File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-%s', $context->{release} ) );
269
8a483da6 270 # initially we move the exim-src directory to the new directory name
46c573de
NM
271 rename( File::Spec->catdir( $context->{release_tree}, 'src' ), $context->{eximpkgdir} )
272 || croak "Rename of src dir failed - $!";
8a483da6
NM
273
274 # add Local subdirectory
46c573de 275 mkpath( File::Spec->catdir( $context->{eximpkgdir}, 'Local' ), { verbose => ( $verbose || $debug ) } );
8a483da6
NM
276
277 # now add the text docs
278 move_text_docs_into_pkg($context);
279}
280
281# ------------------------------------------------------------------
282
283sub build_package_directories {
284 my $context = shift;
285
286 build_main_package_directory($context);
287 build_pspdfinfo_directory($context);
8a483da6
NM
288}
289
290# ------------------------------------------------------------------
291
46c573de
NM
292sub do_cleanup {
293 my $context = shift;
294
295 print "Cleaning up\n" if ($verbose);
296 rmtree( $context->{release_tree}, { verbose => $debug } );
297 rmtree( $context->{docbook}, { verbose => $debug } );
298 rmtree( $context->{pkgdirs}, { verbose => $debug } );
299}
300
301# ------------------------------------------------------------------
302
9d0311ff
PP
303# We prefer gtar to tar if gtar exists in $PATH
304
305sub fix_paths_tar {
306 my $context = shift;
307 my $tar = $context->{tar_cmd};
308
309 return unless $tar eq 'tar';
310
311 foreach my $d (File::Spec->path()) {
312 my $p = File::Spec->catfile($d, 'gtar');
313 if (-x $p) {
314 $context->{tar_cmd} = $p;
315 print "Switched tar command to: $p\n" if ($verbose);
316 return;
317 }
318 }
319}
320
321# ------------------------------------------------------------------
322
8a483da6
NM
323sub create_tar_files {
324 my $context = shift;
325
46c573de
NM
326 my $pkgs = $context->{pkgs};
327 my $pkgdirs = $context->{pkgdirs};
9d0311ff
PP
328 my $tar = $context->{tar_cmd};
329 if ($verbose) {
330 foreach my $c (keys %{ $context->{compressors} }) {
331 print "Compression: $c\t$context->{compressors}{$c}\n";
332 }
333 }
334
46c573de
NM
335 foreach my $dir ( glob( File::Spec->catdir( $pkgdirs, ( 'exim*-' . $context->{release} ) ) ) ) {
336 my $dirname = ( File::Spec->splitdir($dir) )[-1];
9d0311ff 337 if ($context->{compressors}{gzip}) {
03b76468 338 print "Creating: ${pkgs}/${dirname}.tar.gz\n" if ($verbose || $debug);
9d0311ff
PP
339 system("$tar cf ${pkgs}/${dirname}.tar.gz --gzip -C ${pkgdirs} ${dirname}")
340 }
341 if ($context->{compressors}{bzip2}) {
03b76468 342 print "Creating: ${pkgs}/${dirname}.tar.bz2\n" if ($verbose || $debug);
9d0311ff
PP
343 system("$tar cf ${pkgs}/${dirname}.tar.bz2 --bzip2 -C ${pkgdirs} ${dirname}")
344 }
345 if ($context->{compressors}{lzip}) {
03b76468 346 print "Creating: ${pkgs}/${dirname}.tar.lz\n" if ($verbose || $debug);
9d0311ff
PP
347 system("$tar cf ${pkgs}/${dirname}.tar.lz --lzip -C ${pkgdirs} ${dirname}")
348 }
8a483da6
NM
349 }
350}
351
352# ------------------------------------------------------------------
353{
354 my $man;
355 my $help;
356 my $context = {
be914e6c
NM
357 pkgname => 'exim',
358 orig_dir => File::Spec->curdir(),
359 tmp_dir => File::Temp->newdir(),
360 webgen_base => "$FindBin::Bin/../../../exim-website",
9d0311ff
PP
361 tar_cmd => 'tar',
362 compressors => {
363 gzip => 1,
364 bzip2 => 1,
e099cd0d 365 lzip => 0,
9d0311ff 366 },
8a483da6
NM
367 };
368 my $delete;
46c573de 369 my $cleanup = 1;
8f29c950 370 ##$ENV{'PATH'} = '/opt/local/bin:' . $ENV{'PATH'};
8a483da6
NM
371
372 unless (
373 GetOptions(
be914e6c
NM
374 'directory=s' => \$context->{directory},
375 'webgen_base=s' => \$context->{webgen_base},
9d0311ff
PP
376 'tar' => \$context->{tar_cmd},
377 'lzip!' => \$context->{compressors}{lzip},
be914e6c
NM
378 'verbose!' => \$verbose,
379 'debug!' => \$debug,
380 'help|?' => \$help,
381 'man!' => \$man,
382 'delete!' => \$delete,
46c573de 383 'cleanup!' => \$cleanup,
8a483da6
NM
384 )
385 )
386 {
387 pod2usage( -exitval => 1, -verbose => 0 );
388 }
389 pod2usage(0) if $help;
390 pod2usage( -verbose => 2 ) if $man;
391
be914e6c 392 get_and_check_version( shift, $context );
9d0311ff 393 fix_paths_tar($context);
be914e6c 394 $context->{tag} = build_tag($context);
8a483da6 395 deal_with_working_directory( $context, $delete );
8f29c950 396 export_git_tree($context);
8a483da6 397 chdir( $context->{directory} ) || die;
8f29c950 398 unpack_tree($context);
5901f0ab 399 make_version_script($context);
8a483da6
NM
400 build_documentation($context);
401 build_package_directories($context);
402 create_tar_files($context);
46c573de 403 do_cleanup($context) if ($cleanup);
8a483da6
NM
404}
405
4061;
407
408__END__
409
410=head1 NAME
411
412mk_exim_release.pl - Build an exim release
413
414=head1 SYNOPSIS
415
416mk_exim_release.pl [options] version
417
418 Options:
419 --debug force debug mode (SQL Trace)
420 --verbose force verbose mode
421 --help display this help and exits
422 --man displays man page
9d0311ff 423 --tar=cmd command to use for tar
8a483da6 424 --directory=dir dir to package
9d0311ff 425 --no-lzip do not create .tar.lz files
8a483da6
NM
426 --delete Delete packaging directory at start
427
428=head1 OPTIONS
429
430=over 4
431
432=item B<--debug>
433
434Forces debug mode cause all SQL statements generated by L<DBIx::Class>
435to be output.
436
9d0311ff
PP
437=item B<--tar>
438
439Use to override the path to the tar command; without this, will search for
440gtar, and if not found use tar. Need GNU tar for lzip, unless --no-lzip is
441used.
442
e099cd0d 443=item B<--lzip>
9d0311ff 444
e099cd0d 445Build the lzip tarballs.
9d0311ff 446
8a483da6
NM
447=item B<--verbose>
448
9d0311ff 449Force verbose mode
8a483da6
NM
450
451=item B<--help>
452
453Display help and exits
454
455=item B<--man>
456
457Display man page
458
459=back
460
461=head1 DESCRIPTION
462
463Builds an exim release.
464
8f29c950
NM
465Starting in a populated git repo that has already been tagged for
466release, build docs, build packages etc.
8a483da6
NM
467
468Parameter is the version number to build as - ie 4.72 4.72RC1 etc
469
470=head1 AUTHOR
471
472Nigel Metheringham <Nigel.Metheringham@dev.intechnology.co.uk>
473
474=head1 COPYRIGHT
475
8f29c950 476Copyright 2010 Exim Maintainers. All rights reserved.
8a483da6
NM
477
478=cut
9d0311ff 479# vim: set sw=4 et :