Open umask before creating release packages
[exim.git] / release-process / scripts / mk_exim_release
CommitLineData
46c573de 1#!/usr/bin/env perl
80fea873 2# Copyright (c) The Exim Maintainers 2016
3634fc25 3
8a483da6
NM
4use strict;
5use warnings;
6use Carp;
7use File::Copy;
8use File::Spec;
9use File::Path;
8f29c950 10use File::Temp;
be914e6c 11use FindBin;
8a483da6 12use Getopt::Long;
ba41f854 13use IO::File;
8a483da6
NM
14use Pod::Usage;
15
16my $debug = 0;
17my $verbose = 0;
18
19# ------------------------------------------------------------------
20
21sub get_and_check_version {
22 my $release = shift;
be914e6c 23 my $context = shift;
8a483da6
NM
24
25 # make sure this looks like a real release version
9677df8a
HSHR
26 # which should (currently) be 4.xx[.y] or 4.xx[.y]_RCx
27 unless ( $release =~ /^(?<release>(?<major>4\.\d\d)(?:\.(?<minor>\d+))?(?:_RC\d+)?)$/ ) {
8a483da6
NM
28 croak "The given version number does not look right - $release";
29 }
9677df8a
HSHR
30 $context->{release} = $+{release};
31 $context->{major} = $+{major};
32 $context->{minor} = $+{minor};
be914e6c 33
9677df8a 34 ($context->{trelease} = $+{release}) =~ s/_RC\d+//;
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} );
8f29c950 90 # run git command
8a483da6
NM
91 print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
92 system(@cmd) == 0 || croak "Export failed";
93}
94
95# ------------------------------------------------------------------
96
8f29c950
NM
97sub unpack_tree {
98 my $context = shift;
99
100 die "Cannot see archive file\n" unless ( -f $context->{tmp_archive_file} );
46c573de 101 my @cmd = ( 'tar', 'xf', $context->{tmp_archive_file}, '-C', $context->{release_tree} );
8f29c950
NM
102
103 # run command
104 print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
105 system(@cmd) == 0 || croak "Unpack failed";
106}
107
108# ------------------------------------------------------------------
109
5901f0ab 110sub make_version_script {
ba41f854
PP
111 my $context = shift;
112
ba41f854
PP
113 my $variant = substr( $context->{release}, length($context->{trelease}) );
114 if ( $context->{release} ne $context->{trelease} . $variant ) {
115 die "Broken version numbering, I'm buggy";
116 }
5901f0ab 117
ba41f854 118 my $srcdir = File::Spec->catdir( $context->{release_tree}, 'src', 'src' );
3ec6ea71 119 chdir $srcdir or die "chdir $srcdir: $!\n";
5901f0ab
TF
120
121 if ( -f "version.sh" ) {
122 print( "WARNING: version.sh already exists - leaving it in place\n" );
ba41f854
PP
123 return;
124 }
125
9677df8a
HSHR
126 # Currently (25. Feb. 2016) the mk_exim_release.pl up to now can't
127 # deal with security releases.!? So we need a current
128 # mk_exim_release.pl. But if we use a current (master), the
129 # reversion script returns wrong version info (it's running inside
130 # the Git tree and uses git --describe, which always returns the
131 # current version of master.) I do not want to change the old
132 # reversion scripts (in 4.86.1, 4.85.1).
133 #
134 # Thus we've to provide the version.sh, based on the info we have
135 # about the release. If reversion finds this, it doesn't try to find
136 # it's own way to get a valid version number from the git.
137 open(my $v, '>', 'version.sh') or die "Can't open '>version.sh' $!\n";
138 print {$v} <<__;
139# initial version automatically generated from $0
140EXIM_RELEASE_VERSION=$context->{major}
141EXIM_VARIANT_VERSION=@{[$context->{minor}?'_'.$context->{minor}:'']}
142EXIM_COMPILE_NUMBER=0
143__
144 close($v);
145 unlink 'version.h';
146 return;
147
148 # Later, if we get the reversion script fixed, we can call it again.
149 # For now (25. Feb. 2016) we'll leave it unused.
150 my @cmd = ("../scripts/reversion", "release", $context->{tag});
5901f0ab
TF
151 print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
152 system(@cmd) == 0 || croak "reversion failed";
153
154 unlink "version.h";
ba41f854 155
9677df8a 156 -f "version.sh" or die "failed to create version.sh";
ba41f854
PP
157}
158
159# ------------------------------------------------------------------
160
be914e6c
NM
161sub build_html_documentation {
162 my $context = shift;
163
164 my $genpath = $context->{webgen_base} . '/script/gen.pl';
165 my $templates = $context->{webgen_base} . '/templates';
46c573de
NM
166 my $dir = File::Spec->catdir( $context->{release_tree}, 'html' );
167 my $spec = File::Spec->catfile( $context->{docbook}, 'spec.xml' );
168 my $filter = File::Spec->catfile( $context->{docbook}, 'filter.xml' );
169
be914e6c
NM
170 mkdir($dir);
171
cd6d74ab
NM
172 my @cmd = (
173 $genpath, '--spec', $spec, '--filter',
174 $filter, '--latest', $context->{trelease}, '--tmpl',
e14fcb3b 175 $templates, '--docroot', $dir, '--localstatic'
cd6d74ab 176 );
e14fcb3b 177 push @cmd, '--verbose' if $verbose or $debug;
be914e6c
NM
178
179 print "Executing ", join( ' ', @cmd ), "\n";
180 system(@cmd);
181
182 # move directory into right place
46c573de
NM
183 my $sourcedir = File::Spec->catdir( $context->{docbook}, 'filter.xml' );
184
185 rename(
186 File::Spec->catdir( $dir, sprintf( 'exim-html-%s', $context->{trelease} ) ),
187 File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-html-%s', $context->{release} ) )
188 );
189}
190
191# ------------------------------------------------------------------
192
193sub copy_docbook_files {
194 my $context = shift;
195
196 # where the generated docbook files can be found
197 my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
198
199 # where the website docbook source dir is - push files to here
200 my $webdir = File::Spec->catdir( $context->{webgen_base}, 'docbook', $context->{trelease} );
201 mkpath( $webdir, { verbose => ( $verbose || $debug ) } );
202
203 foreach my $file ( 'spec.xml', 'filter.xml' ) {
204 my $from = File::Spec->catfile( $docdir, $file );
205 my $to = File::Spec->catfile( $context->{docbook}, $file );
206 my $webto = File::Spec->catfile( $webdir, $file );
207 copy( $from, $to );
208 copy( $from, $webto );
209 }
be914e6c
NM
210}
211
212# ------------------------------------------------------------------
213
8a483da6 214sub build_documentation {
be914e6c
NM
215 my $context = shift;
216
46c573de 217 my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
39d16d73 218 # documentation building gets the truncated release, without RC
a7637438 219 system("cd '$docdir' && ./OS-Fixups && $context->{make_cmd} EXIM_VER=$context->{trelease} everything") == 0
8a483da6 220 || croak "Doc build failed";
be914e6c 221
46c573de 222 copy_docbook_files($context);
2820726f 223 build_html_documentation($context) if $context->{web};
8a483da6
NM
224}
225
226# ------------------------------------------------------------------
227
228sub move_text_docs_into_pkg {
229 my $context = shift;
230
821bc55f
PP
231 my $old_docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
232 my $old_txtdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-txt' );
46c573de 233 my $new_docdir = File::Spec->catdir( $context->{eximpkgdir}, 'doc' );
8a483da6
NM
234 mkpath( $new_docdir, { verbose => ( $verbose || $debug ) } );
235
236 # move generated documents from docbook stuff
237 foreach my $file (qw/exim.8 spec.txt filter.txt/) {
238 move( File::Spec->catfile( $old_docdir, $file ), File::Spec->catfile( $new_docdir, $file ) );
239 }
240
241 # move text documents across
821bc55f 242 foreach my $file ( glob( File::Spec->catfile( $old_txtdir, '*' ) ) ) {
8a483da6
NM
243
244 # skip a few we dont want
245 my $fn = ( File::Spec->splitpath($file) )[2];
246 next
247 if ( ( $fn eq 'ABOUT' )
248 || ( $fn eq 'ChangeLog.0' )
3394b36a
TL
249 || ( $fn eq 'test-harness.txt' )
250 # Debian issue re licensing of RFCs
251 || ( $fn =~ /^draft-ietf-.*/ )
252 || ( $fn =~ /^rfc.*/ )
253 );
8a483da6
NM
254 move( $file, File::Spec->catfile( $new_docdir, $fn ) );
255 }
256}
257
258# ------------------------------------------------------------------
259
260sub build_pspdfinfo_directory {
261 my $context = shift;
262
263 ##foreach my $format (qw/pdf postscript texinfo info/) {
264 foreach my $format (qw/pdf postscript/) {
46c573de 265 my $target = File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-%s-%s', $format, $context->{release} ), 'doc' );
8a483da6
NM
266 mkpath( $target, { verbose => ( $verbose || $debug ) } );
267
268 # move documents across
269 foreach my $file (
270 glob(
271 File::Spec->catfile(
46c573de
NM
272 $context->{release_tree},
273 'doc',
274 'doc-docbook',
8a483da6
NM
275 (
276 ( $format eq 'postscript' )
277 ? '*.ps'
278 : ( '*.' . $format )
279 )
280 )
281 )
282 )
283 {
46c573de 284 move( $file, File::Spec->catfile( $target, ( File::Spec->splitpath($file) )[2] ) );
8a483da6
NM
285 }
286 }
287}
288
289# ------------------------------------------------------------------
290
8a483da6
NM
291sub build_main_package_directory {
292 my $context = shift;
293
46c573de
NM
294 # build the exim package directory path
295 $context->{eximpkgdir} = File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-%s', $context->{release} ) );
296
8a483da6 297 # initially we move the exim-src directory to the new directory name
46c573de
NM
298 rename( File::Spec->catdir( $context->{release_tree}, 'src' ), $context->{eximpkgdir} )
299 || croak "Rename of src dir failed - $!";
8a483da6
NM
300
301 # add Local subdirectory
46c573de 302 mkpath( File::Spec->catdir( $context->{eximpkgdir}, 'Local' ), { verbose => ( $verbose || $debug ) } );
8a483da6
NM
303
304 # now add the text docs
305 move_text_docs_into_pkg($context);
306}
307
308# ------------------------------------------------------------------
309
310sub build_package_directories {
311 my $context = shift;
312
313 build_main_package_directory($context);
9677df8a 314 build_pspdfinfo_directory($context) if $context->{build_docs};
8a483da6
NM
315}
316
317# ------------------------------------------------------------------
318
46c573de
NM
319sub do_cleanup {
320 my $context = shift;
321
322 print "Cleaning up\n" if ($verbose);
3ec6ea71 323 chdir( $context->{directory} ) || die;
46c573de
NM
324 rmtree( $context->{release_tree}, { verbose => $debug } );
325 rmtree( $context->{docbook}, { verbose => $debug } );
326 rmtree( $context->{pkgdirs}, { verbose => $debug } );
327}
328
329# ------------------------------------------------------------------
330
9d0311ff
PP
331# We prefer gtar to tar if gtar exists in $PATH
332
333sub fix_paths_tar {
334 my $context = shift;
335 my $tar = $context->{tar_cmd};
336
337 return unless $tar eq 'tar';
338
339 foreach my $d (File::Spec->path()) {
340 my $p = File::Spec->catfile($d, 'gtar');
341 if (-x $p) {
342 $context->{tar_cmd} = $p;
343 print "Switched tar command to: $p\n" if ($verbose);
344 return;
345 }
346 }
347}
348
349# ------------------------------------------------------------------
350
8a483da6
NM
351sub create_tar_files {
352 my $context = shift;
353
46c573de
NM
354 my $pkgs = $context->{pkgs};
355 my $pkgdirs = $context->{pkgdirs};
9d0311ff
PP
356 my $tar = $context->{tar_cmd};
357 if ($verbose) {
358 foreach my $c (keys %{ $context->{compressors} }) {
359 print "Compression: $c\t$context->{compressors}{$c}\n";
360 }
361 }
362
46c573de
NM
363 foreach my $dir ( glob( File::Spec->catdir( $pkgdirs, ( 'exim*-' . $context->{release} ) ) ) ) {
364 my $dirname = ( File::Spec->splitdir($dir) )[-1];
9d0311ff 365 if ($context->{compressors}{gzip}) {
03b76468 366 print "Creating: ${pkgs}/${dirname}.tar.gz\n" if ($verbose || $debug);
9d0311ff
PP
367 system("$tar cf ${pkgs}/${dirname}.tar.gz --gzip -C ${pkgdirs} ${dirname}")
368 }
369 if ($context->{compressors}{bzip2}) {
03b76468 370 print "Creating: ${pkgs}/${dirname}.tar.bz2\n" if ($verbose || $debug);
9d0311ff
PP
371 system("$tar cf ${pkgs}/${dirname}.tar.bz2 --bzip2 -C ${pkgdirs} ${dirname}")
372 }
373 if ($context->{compressors}{lzip}) {
03b76468 374 print "Creating: ${pkgs}/${dirname}.tar.lz\n" if ($verbose || $debug);
9d0311ff
PP
375 system("$tar cf ${pkgs}/${dirname}.tar.lz --lzip -C ${pkgdirs} ${dirname}")
376 }
8a483da6
NM
377 }
378}
379
380# ------------------------------------------------------------------
91bde4a0
HSHR
381MAIN: {
382
383 $0 =~ m|^(?:\./)?release-process/scripts/|
384 or die "$0: please call this script from the root of the Exim project sources\n";
385
8a483da6 386 my $context = {
be914e6c
NM
387 pkgname => 'exim',
388 orig_dir => File::Spec->curdir(),
389 tmp_dir => File::Temp->newdir(),
390 webgen_base => "$FindBin::Bin/../../../exim-website",
9d0311ff 391 tar_cmd => 'tar',
a7637438 392 make_cmd => 'make',
9d0311ff
PP
393 compressors => {
394 gzip => 1,
395 bzip2 => 1,
e099cd0d 396 lzip => 0,
9d0311ff 397 },
9677df8a 398 build_docs => 1,
2820726f 399 web => 1,
8a483da6
NM
400 };
401 my $delete;
46c573de 402 my $cleanup = 1;
8f29c950 403 ##$ENV{'PATH'} = '/opt/local/bin:' . $ENV{'PATH'};
8a483da6 404
91bde4a0
HSHR
405 GetOptions(
406 'directory=s' => \$context->{directory},
407 'webgen_base=s' => \$context->{webgen_base},
408 'tar=s' => \$context->{tar_cmd},
409 'make=s' => \$context->{make_cmd},
410 'lzip!' => \$context->{compressors}{lzip},
411 'verbose!' => \$verbose,
412 'debug!' => \$debug,
413 'help|?' => sub { pod2usage(-verbose => 1, -exit => 0) },
414 'man!' => sub { pod2usage(-verbose => 2, -exit => 0, -noperldoc => system('perldoc -V >/dev/null 2>&1')) },
415 'delete!' => \$delete,
416 'cleanup!' => \$cleanup,
417 'build-docs!' => \$context->{build_docs},
418 'web!' => \$context->{web},
419 ) and @ARGV == 1 or pod2usage;
8a483da6 420
25af913a 421 umask(022);
be914e6c 422 get_and_check_version( shift, $context );
9d0311ff 423 fix_paths_tar($context);
be914e6c 424 $context->{tag} = build_tag($context);
8a483da6 425 deal_with_working_directory( $context, $delete );
8f29c950 426 export_git_tree($context);
8a483da6 427 chdir( $context->{directory} ) || die;
8f29c950 428 unpack_tree($context);
5901f0ab 429 make_version_script($context);
9677df8a 430 build_documentation($context) if $context->{build_docs};
8a483da6
NM
431 build_package_directories($context);
432 create_tar_files($context);
46c573de 433 do_cleanup($context) if ($cleanup);
8a483da6
NM
434}
435
4361;
437
438__END__
439
440=head1 NAME
441
6bfa380e 442mk_exim_release - Build an exim release
8a483da6
NM
443
444=head1 SYNOPSIS
445
91bde4a0
HSHR
446 mk_exim_release [options] version
447
448=head1 DESCRIPTION
449
450B<mk_exim_release> builds an exim release.
451
452Starting in a populated git repo that has already been tagged for
453release it builds docs, packages etc. Parameter is the version number
454to build as - ie 4.72 4.72RC1, 4.86.1, etc
455
456After creating the release files, they should be signed. There is another
457helper for creating the signatures:
458F<release-process/scripts/sign_exim_packages>.
459
460Call B<mk_exim_release> about like this:
461
462 release-process/scripts/mk_exim_release 4.99
8a483da6 463
8a483da6
NM
464
465=head1 OPTIONS
466
467=over 4
468
91bde4a0 469=item B<--[no]debug>
8a483da6 470
91bde4a0 471Forces debug mode. (default: no debug info)
8a483da6 472
91bde4a0 473=item B<--[no]delete>
9d0311ff 474
91bde4a0 475Delete a pre-existing package directory at start. (default: don't delete)
9d0311ff 476
91bde4a0 477=item B<--directory> I<dir>
a7637438 478
91bde4a0 479Change the name of the package directory (default: F<< exim-packaging-<version> >>)
a7637438 480
91bde4a0 481=item B<--[no]help>
9d0311ff 482
91bde4a0 483Display short help and exit cleanly. (default: don't do that)
9d0311ff 484
91bde4a0 485=item B<--[no]lzip>
8a483da6 486
91bde4a0 487Control the creation of B<lzip> tarballs. (default: do not use lzip)
8a483da6 488
91bde4a0 489=item B<--make> I<cmd>
8a483da6 490
91bde4a0
HSHR
491Force the use of a specific C<make> command. This may be necessary if C<make> is not
492C<gmake> (default: C<make>)
8a483da6 493
91bde4a0 494=item B<--[no]man>
8a483da6 495
91bde4a0 496Display man page and exit cleanly. (default: don't do that)
8a483da6 497
91bde4a0 498=item B<--tar> I<cmd>
8a483da6 499
91bde4a0
HSHR
500Use to override the path to the C<tar> command. Need GNU tar in case
501I<lzip> is selected. (default: C<gtar>, if not found, use C<tar>)
8a483da6 502
91bde4a0 503=item B<--[no]web>
8a483da6 504
91bde4a0
HSHR
505Control the creation of the website. For creation of the website, the F<../exim-website>
506directory must exist. (default: create the website)
8a483da6 507
91bde4a0
HSHR
508=item B<--verbose>
509
510Force verbose mode. (default: no verbosity)
511
512=back
8a483da6
NM
513
514=head1 AUTHOR
515
91bde4a0
HSHR
516Nigel Metheringham <Nigel.Metheringham@dev.intechnology.co.uk>,
517some changes by Heiko Schlittermann <hs@schlittermann.de>
8a483da6
NM
518
519=head1 COPYRIGHT
520
91bde4a0 521Copyright 2010-2016 Exim Maintainers. All rights reserved.
8a483da6
NM
522
523=cut
9d0311ff 524# vim: set sw=4 et :