Testsuite: output changes resulting
[exim.git] / release-process / scripts / mk_exim_release
CommitLineData
46c573de 1#!/usr/bin/env perl
525c441c 2# Copyright (c) The Exim Maintainers 2016-2018
3634fc25 3
8a483da6
NM
4use strict;
5use warnings;
6use Carp;
525c441c
HSHR
7use Cwd qw'abs_path';
8use File::Basename;
9use File::Path qw(make_path remove_tree);
8f29c950 10use File::Temp;
8a483da6 11use Getopt::Long;
ba41f854 12use IO::File;
8a483da6 13use Pod::Usage;
162e16b1 14use Digest::SHA;
b3fadca5 15use feature 'state';
525c441c
HSHR
16use if $ENV{DEBUG} => 'Smart::Comments';
17
18my $ME = basename $0;
19
8a483da6 20
cbae9e74 21my $debug = undef;
8a483da6
NM
22my $verbose = 0;
23
525c441c
HSHR
24# MAJOR.MINOR[.SECURITY[.FIXES]][-RCX]
25# 4 .90 .0 .22 -RC1
26my $version_pattern = qr/
27 (?<release>
cbae9e74 28 (?<target_release>
525c441c
HSHR
29 (?<major>\d) # 4
30 \.(?<minor>\d\d) # .90
31 (?:\.(?<security>\d+) # .0
32 (?:\.(?<fixes>)\d+)?)? # .22
cbae9e74 33 ) # target-release ->|
525c441c
HSHR
34 (?:-(?<rc>RC\d+)?)? # -RC1
35 )
36/x;
8a483da6 37
cbae9e74
HSHR
38my $quick_version_pattern = qr/
39 (?<release>
40 (?<last_tag>
41 (?<major>\d) # 4
42 \.(?<minor>\d\d) # .90
43 (?:\.(?<security>\d+) # .0
44 (?:\.(?<fixes>)\d+)?)? # .22
45 ) # last-tag ->|
46 (?:-(?<quick>\d+-g[[:xdigit:]]+))? # -3-gdeadbef
47 )
48/x;
49
525c441c 50# ------------------------------------------------------------------
8a483da6 51
525c441c
HSHR
52package Context {
53 use strict; # not strictly necessary yet, until in an own package
54 use warnings; # not strictly necessary yet, ...
55 use File::Spec::Functions qw'splitpath catfile catdir splitdir';
56 use File::Path qw'make_path remove_tree';
57 use File::Copy;
58 use Cwd qw'abs_path';
59 use Carp;
60
61 package PWD {
62 use Cwd;
63 sub TIESCALAR { bless do {\my $x} }
64 sub FETCH { cwd }
8a483da6 65 }
be914e6c 66
cbae9e74 67 tie my $cwd => 'PWD' or die; # this returns the current dir now, dynamically
8a483da6 68
525c441c
HSHR
69 sub new {
70 my $class = shift;
71 return bless { @_ } => $class;
72 }
8a483da6 73
525c441c
HSHR
74 sub check_version {
75 my $context = shift;
cbae9e74
HSHR
76 my $version = shift // 'HEAD';
77
78 #
79 # v => {
80 # release => 4.92-RC4 | 4.92-27-gabcdef
81 # target_release|last_tag => 4.92 | 4.92
82 #
83 # major => 4
84 # minor => 92
85 # security =>
86 # fixes =>
87 #
88 # rc|quick => RC4 | 27-gabcdef
89 # }
90
cf7e6ba8
HSHR
91 #
92 # v => {
93 # release => 4.92-RC4 | 4.92-27-gabcdef-dirty
94 # target_release|last_tag => 4.92 | 4.92
95 #
96 # major => 4
97 # minor => 92
98 # security =>
99 # fixes =>
100 #
101 # rc|quick => RC4 | 27-gabcdef-dirty
102 # }
103
cbae9e74
HSHR
104 if ($context->{quick}) {
105 # Try to find suitable version description
106 chomp(my $describe = do { # we wrap it into a open() to avoid hassle with
107 open(my $fh, '-|', # strange version descriptions
108 'git', describe => $version) or die;
109 <$fh>
110 } // exit 1);
111 $describe =~ /$quick_version_pattern/;
112
113 %{$context->{v}} = %+;
114 ($context->{commit}) = $version // ($context->{v}{quick} =~ /g([[:xdigit:]]+)/);
115 }
116 else {
117 croak "The given version number does not look right - $version"
118 if not $version =~ /$version_pattern/;
119 %{$context->{v}} = %+;
120
121 # find a valid vcs tag matching the version
122 my $pattern = "$context->{pkgname}-$context->{v}{release}" =~ s/[-_.]/[-_.]/gr;
123 chomp(my @tags = qx{git tag --list '$pattern'});
8a483da6 124
cbae9e74
HSHR
125 croak "The given version is ambigous, tags: @tags\n" if @tags > 1;
126 croak "The given version does not exist (no such tag: exim-$version)\n" if @tags == 0;
8a483da6 127
cbae9e74
HSHR
128 $context->{commit} = $tags[0];
129 # target_release: the release we aim to reach with release candidates
130 # FIXME: re-construct from the parsed version number
131 }
8a483da6 132
b315e9a9
HSHR
133 die "$ME: This script doesn't work for versions prior 4.92-RCx. "
134 ."Please checkout an older version.\n"
aa672401
HSHR
135 if $context->{v}{major} < 4
136 or $context->{v}{major} == 4 && $context->{v}{minor} < 92;
137
525c441c 138 ### v: $context->{v}
8a483da6 139
46c573de 140 }
8a483da6 141
8a483da6 142
525c441c
HSHR
143 # We prefer gtar to tar if gtar exists in $PATH
144 sub override_tar_cmd {
145 my $context = shift;
146 my $tar = $context->{tar_cmd};
8a483da6 147
525c441c 148 return unless $tar eq 'tar';
8a483da6 149
525c441c
HSHR
150 foreach my $d (File::Spec->path()) {
151 my $p = catfile($d, 'gtar');
152 if (-x $p) {
153 $context->{tar_cmd} = $p;
154 print "Switched tar command to: $p\n" if $verbose;
155 return;
156 }
157 }
158 }
8a483da6 159
525c441c
HSHR
160 sub prepare_working_directory {
161 my $context = shift;
162 my $workspace = $context->{workspace};
8f29c950 163
525c441c
HSHR
164 if (not defined $workspace) {
165 $workspace = $context->{workspace} = File::Temp->newdir(File::Spec->tmpdir . '/exim-packaging-XXXX');
166 }
167 else {
168 # ensure the working directory is not in place
169 if (-e $workspace) {
170 if ($context->{delete}) {
171 print "Deleting existing $workspace\n" if $verbose;
172 remove_tree $workspace, { verbose => $verbose || $debug };
173 }
174 else {
175 croak "Working directory $workspace exists" if -e $workspace;
176 }
177 }
178
179 # create base directory
180 make_path( $context->{directory}, { verbose => $verbose || $debug } );
181 }
8f29c950 182
525c441c
HSHR
183 # Set(!) and create subdirectories
184 foreach (qw(vcs_export pkg_tars pkg_trees tmp)) { # {dookbook}
185 make_path(
186 $context->{d}{$_} = catdir($workspace, $_),
187 { verbose => $verbose || $debug });
188 }
189 }
8f29c950 190
525c441c
HSHR
191 sub export_git_tree {
192 my $context = shift;
193
194 # build git command
195 my $archive_file = $context->{tmp_archive_file} = sprintf'%s/%s-%s.tar', $context->{d}{tmp}, $context->{pkgname}, $context->{v}{release};
196 ### $archive_file
cbae9e74 197 my @cmd = ( 'git', 'archive', '--format=tar', "--output=$archive_file", $context->{commit} );
525c441c
HSHR
198 ### @cmd
199 # run git command
200 print "[$cwd] Running: @cmd\n" if $verbose;
201 0 == system @cmd or croak "Export failed";
202 }
8f29c950 203
525c441c
HSHR
204 sub unpack_tree {
205 # TODO: Why can't we combine the export_git_tree with the
206 # unpack_tree function?
207 my $context = shift;
ba41f854 208
525c441c
HSHR
209 ### $context
210 die "Cannot see archive file\n" unless -f $context->{tmp_archive_file};
211 my @cmd = ('tar',
212 xf => $context->{tmp_archive_file},
213 -C => $context->{d}{vcs_export} );
5901f0ab 214
525c441c
HSHR
215 # run command
216 print "[$cwd] Running: @cmd\n" if $verbose;
217 system @cmd and croak "Unpack failed\n";
5901f0ab 218
ba41f854
PP
219 }
220
525c441c
HSHR
221 sub make_version_script {
222 my $context = shift;
223
224 #my $variant = substr( $context->{v}{release}, length($context->{v}{target_release}) );
225 #if ( $context->{v}{release} ne $context->{v}{target_release} . $variant ) {
226 # die "Broken version numbering, I'm buggy";
227 #}
228
229
230 # Work
231 if (not my $pid = fork // die "$ME: Cannot fork: $!\n") {
232
233 my $source_tree = catdir($context->{d}{vcs_export}, 'src', 'src');
234 ### $source_tree
235
236 chdir $source_tree or die "chdir $source_tree: $!\n";
237
525c441c
HSHR
238 croak "WARNING: version.sh already exists - leaving it in place\n"
239 if -f 'version.sh';
240
241 # Currently (25. Feb. 2016) the mk_exim_release.pl up to now can't
242 # deal with security releases.!? So we need a current
243 # mk_exim_release.pl. But if we use a current (master), the
244 # reversion script returns wrong version info (it's running inside
245 # the Git tree and uses git --describe, which always returns the
246 # current version of master.) I do not want to change the old
247 # reversion scripts (in 4.86.1, 4.85.1).
248 #
249 # Thus we've to provide the version.sh, based on the info we have
250 # about the release. If reversion finds this, it doesn't try to find
251 # it's own way to get a valid version number from the git.
252 #
253 # 4.89 series: the logic here did not handle _RC<N> thus breaking RC
254 # status in versions. nb: rc in context should be same as $variant
255 # in local context.
256
257 #my $stamp = $context->{minor} ? '_'.$context->{minor} : '';
258 #$stamp .= $context->{rc} if $context->{rc};
cbae9e74
HSHR
259 my $release = $context->{v}{rc} ? $context->{v}{target_release}
260 : $context->{v}{last_tag};
261
262 my $variant =
263 $context->{v}{rc} ? $context->{v}{rc}
264 : $context->{v}{quick} ? $context->{v}{quick}
265 : '';
525c441c
HSHR
266
267 print "[$cwd] create version.sh\n" if $verbose;
268 open(my $v, '>', 'version.sh') or die "Can't open version.sh for writing: $!\n";
269 print {$v} <<__;
270# initial version automatically generated by $0
cbae9e74 271EXIM_RELEASE_VERSION=$release
525c441c 272EXIM_VARIANT_VERSION=$variant
9677df8a 273EXIM_COMPILE_NUMBER=0
525c441c 274# echo "[[[ \$EXIM_RELEASE_VERSION | \$EXIM_VARIANT_VERSION | \$EXIM_COMPILE_NUMBER ]]]"
9677df8a 275__
525c441c
HSHR
276 close $v or die "$0: Can not close $source_tree/version.h: $!\n";
277 unlink 'version.h' or die "$ME: Can not unlink $source_tree/version.h: $!\n"
278 if -f 'version.h';
9677df8a 279
525c441c
HSHR
280 # Later, if we get the reversion script fixed, we can call it again.
281 # For now (25. Feb. 2016) we'll leave it unused.
cbae9e74 282 #my @cmd = ('../scripts/reversion', 'release', $context->{commit});
5901f0ab 283
525c441c
HSHR
284 my @cmd = ('../scripts/reversion', 'release');
285 print "[$cwd] Running: @cmd\n" if $verbose;
286 system(@cmd) and croak "reversion failed";
ba41f854 287
525c441c
HSHR
288 die "$ME: failed to create version.sh"
289 unless -f 'version.sh';
ba41f854 290
525c441c
HSHR
291 exit 0;
292 }
293 else {
294 $pid == waitpid($pid, 0) or die "$0: waidpid: $!\n";
295 exit $? >> 8 if $?;
296 }
297 }
ba41f854 298
525c441c
HSHR
299 sub build_documentation {
300 my $context = shift;
301 my $docdir = catdir $context->{d}{vcs_export}, 'doc', 'doc-docbook';
302
303 # documentation building does a chdir, so we'll do it in a
304 # subprocess
305 if (not my $pid = fork // die "$ME: Can't fork: $!\n") {
306 chdir $docdir or die "$ME: Can't chdir to $docdir: $!\n";
307 system('./OS-Fixups') == 0 or exit $?;
308 exec $context->{make_cmd},
cf7e6ba8
HSHR
309 "EXIM_VER=$context->{v}{release}", 'everything'
310 or die "$ME: [$cwd] Cannot exec $context->{make_cmd}: $!\n";
525c441c
HSHR
311 }
312 else {
313 waitpid($pid, 0);
314 exit $? >> 8 if $?;
315 }
be914e6c 316
525c441c 317 $context->copy_docbook_files;
525c441c 318 }
46c573de 319
525c441c
HSHR
320 sub copy_docbook_files {
321 my $context = shift;
be914e6c 322
525c441c
HSHR
323 # where the generated docbook files can be found
324 my $docdir = catdir $context->{d}{vcs_export}, 'doc', 'doc-docbook';
be914e6c 325
525c441c
HSHR
326 foreach ('spec.xml', 'filter.xml') {
327 my $from = catfile $docdir, $_;
328 my $to = catdir $context->{d}{tmp}; # {dookbook}
329 copy $from => $to or die $@;
330 }
331 }
be914e6c 332
525c441c
HSHR
333 sub build_html_documentation {
334 my $context = shift;
46c573de 335
525c441c
HSHR
336 # where the website docbook source dir is - push the generated
337 # files there
338 {
339 my $webdir = catdir $context->{website_base}, 'docbook', $context->{v}{target_release};
cbae9e74 340 make_path $webdir, { verbose => $verbose || $debug };
525c441c
HSHR
341 copy catfile($context->{d}{vcs_export}, 'doc', 'doc-docbook', $_)
342 => $webdir or die $@
343 for 'spec.xml', 'filter.xml';
344 }
46c573de 345
525c441c
HSHR
346 my $gen = catfile $context->{website_base}, 'script/gen';
347 my $outdir = catdir $context->{d}{pkg_trees}, "exim-html-$context->{v}{release}";
46c573de 348
525c441c 349 make_path $outdir, { verbose => $verbose || $debug };
46c573de 350
525c441c
HSHR
351 my @cmd = (
352 $gen,
353 '--spec' => catfile($context->{d}{tmp}, 'spec.xml'), # {dookbook}
354 '--filter' => catfile($context->{d}{tmp}, 'filter.xml'), # {dookbok}
355 '--latest' => $context->{v}{target_release},
356 '--docroot' => $outdir,
357 '--localstatic',
358 ($verbose || $debug ? '--verbose' : ()),
359 );
46c573de 360
525c441c
HSHR
361 print "[$cwd] Executing @cmd\n";
362 0 == system @cmd or exit $? >> 8;
46c573de 363
46c573de 364 }
be914e6c 365
162e16b1
HSHR
366 sub sign {
367 my $context = shift;
368 foreach my $tar (glob "$context->{d}{pkg_tars}/*") {
369 system gpg =>
370 '--quiet', '--batch',
371 defined $context->{gpg}{key}
372 ? ('--local-user' => $context->{gpg}{key})
373 : (),
374 '--detach-sig', '--armor', $tar;
375 }
376 }
377
525c441c
HSHR
378 sub move_to_outdir {
379 my $context = shift;
380 make_path $context->{OUTDIR}, { verbose => $verbose || $debug };
381 move $_ => $context->{OUTDIR} or die $@
382 for glob "$context->{d}{pkg_tars}/*";
383 }
8a483da6 384
525c441c
HSHR
385 sub build_src_package_directory {
386 my $context = shift;
8a483da6 387
525c441c
HSHR
388 # build the exim package directory path
389 $context->{d}{src} = catdir $context->{d}{pkg_trees}, "exim-$context->{v}{release}";
8a483da6 390
525c441c
HSHR
391 # initially we move the exim-src directory to the new directory name
392 move
393 catdir( $context->{d}{vcs_export}, 'src')
394 => $context->{d}{src}
395 or croak "Move of src dir failed - $!";
8a483da6 396
525c441c
HSHR
397 # add Local subdirectory
398 make_path( catdir( $context->{d}{src}, 'Local' ), { verbose => $verbose || $debug } );
8a483da6 399
525c441c
HSHR
400 # now add the text docs
401 $context->move_text_docs_into_pkg;
8a483da6 402 }
8a483da6 403
525c441c
HSHR
404 sub build_doc_packages_directory {
405 my $context = shift;
406
407 ##foreach my $format (qw/pdf postscript texinfo info/) {
408 foreach my $format (qw/pdf postscript/) {
409 my $target = catdir $context->{d}{pkg_trees}, "exim-$format-$context->{v}{release}", 'doc';
410 make_path( $target, { verbose => $verbose || $debug } );
411
412 # move documents across
413 foreach my $file (
414 glob(
415 catfile(
416 $context->{d}{vcs_export},
417 'doc',
418 'doc-docbook',
419 (
420 ( $format eq 'postscript' )
421 ? '*.ps'
422 : ( '*.' . $format )
423 )
8a483da6
NM
424 )
425 )
426 )
525c441c
HSHR
427 {
428 move( $file, catfile( $target, ( splitpath($file) )[2] ) );
429 }
8a483da6
NM
430 }
431 }
46c573de 432
525c441c
HSHR
433 sub move_text_docs_into_pkg {
434 my $context = shift;
9d0311ff 435
525c441c
HSHR
436 my $old_docdir = catdir( $context->{d}{vcs_export}, 'doc', 'doc-docbook' );
437 my $old_txtdir = catdir( $context->{d}{vcs_export}, 'doc', 'doc-txt' );
438 my $new_docdir = catdir( $context->{d}{src}, 'doc' );
439 make_path( $new_docdir, { verbose => $verbose || $debug } );
9d0311ff 440
525c441c
HSHR
441 # move generated documents from docbook stuff
442 foreach my $file (qw/exim.8 spec.txt filter.txt/) {
443 die "Empty file \"$file\"\n" if -z catfile( $old_docdir, $file );
444 move( catfile( $old_docdir, $file ), catfile( $new_docdir, $file ) );
445 }
9d0311ff 446
525c441c
HSHR
447 # move text documents across
448 foreach my $file ( glob( catfile( $old_txtdir, '*' ) ) ) {
449
450 # skip a few we dont want
451 my $fn = ( splitpath($file) )[2];
452 next
453 if ( ( $fn eq 'ABOUT' )
454 || ( $fn eq 'ChangeLog.0' )
455 || ( $fn eq 'test-harness.txt' )
456 # Debian issue re licensing of RFCs
457 || ( $fn =~ /^draft-ietf-.*/ )
458 || ( $fn =~ /^rfc.*/ )
459 );
460 move( $file, catfile( $new_docdir, $fn ) );
9d0311ff
PP
461 }
462 }
9d0311ff 463
525c441c
HSHR
464 sub create_tar_files {
465 my $context = shift;
9d0311ff 466
525c441c
HSHR
467 my $pkg_tars = $context->{d}{pkg_tars};
468 my $pkg_trees = $context->{d}{pkg_trees};
469 my $tar = $context->{tar_cmd};
470 if ($verbose) {
471 foreach my $c (keys %{ $context->{compressors} }) {
472 print "Compression: $c\t$context->{compressors}{$c}\n";
473 }
474 }
8a483da6 475
525c441c
HSHR
476 # We ideally do not want local system user information in release tarballs;
477 # those are artifacts of use of tar for backups and have no place in
478 # software release packaging; if someone extracts as root, then they should
479 # get sane file ownerships.
b315e9a9
HSHR
480 my @ownership = (
481 '--owner' => $context->{tar_perms}{user},
482 '--group' => $context->{tar_perms}{group},
525c441c 483 # on this GNU tar, --numeric-owner works during creation too
b315e9a9
HSHR
484 '--numeric-owner'
485 ) if qx/tar --help 2>&1/ =~ /^\s*--owner=/m;
9d0311ff 486
525c441c 487 # See also environment variables set in main, tuning compression levels
b315e9a9 488
162e16b1 489 my (%size, %sha256);
b315e9a9 490
525c441c
HSHR
491 foreach my $dir ( glob( catdir( $pkg_trees, ( 'exim*-' . $context->{v}{release} ) ) ) ) {
492 my $dirname = ( splitdir($dir) )[-1];
ab1aa32a
HSHR
493 foreach my $comp (keys %{$context->{compressors}}) {
494 my %compressor = %{$context->{compressors}{$comp}};
495 next unless $compressor{use};
162e16b1 496
ab1aa32a 497 my $basename = "$dirname.tar.$compressor{extension}";
162e16b1
HSHR
498 my $outfile = catfile $pkg_tars, $basename;
499
500 print "Creating: $outfile\n" if $verbose || $debug;
b315e9a9
HSHR
501 0 == system($tar,
502 cf => $outfile,
ab1aa32a 503 $compressor{flags},
b315e9a9 504 @ownership, -C => $pkg_trees, $dirname)
525c441c 505 or exit $? >> 8;
162e16b1
HSHR
506
507 # calculate size and md5sum
508 $size{$basename} = -s $outfile;
509 $sha256{$basename} = do {
510 my $sha = Digest::SHA->new(256);
511 $sha->addfile($outfile);
512 $sha->hexdigest;
513 };
525c441c
HSHR
514 }
515 }
162e16b1
HSHR
516
517 # write the sizes file
cbae9e74
HSHR
518 if ($context->{sizes}) {
519 open my $sizes, '>', $_ = catfile $pkg_tars, 'sizes.txt'
520 or die "$ME: Can't open `$_': $!\n";
b315e9a9 521
cbae9e74
HSHR
522 print $sizes join "\n",
523 (map { "SIZE($_) = $size{$_}" } sort keys %size),
524 (map { "SHA256($_) = $sha256{$_}" } sort keys %sha256);
b315e9a9 525
cbae9e74
HSHR
526 close($sizes) or die "$ME: Can't close $_: $!\n";
527 }
45b75b0a
PP
528 }
529
525c441c
HSHR
530 sub do_cleanup {
531 my $context = shift;
00f7a87b 532
525c441c 533 print "Cleaning up\n" if $verbose;
cbae9e74 534 remove_tree $context->{d}{tmp}, { verbose => $verbose || $debug };
8a483da6 535 }
00f7a87b 536
8a483da6
NM
537}
538
b3fadca5
HSHR
539# Check, if tar understands --use-compress-program and use this, as
540# at least gzip deprecated passing options via the environment.
541sub compressor {
542 my ($compressor, $fallback) = @_;
543 state $use_compress_option =
544 0 == system("tar c -f /dev/null -C / --use-compress-program=cat dev/null 2>/dev/null");
545 return $use_compress_option
546 ? "--use-compress-program=$compressor"
547 : ref $fallback eq ref sub {} ? $fallback->() : $fallback;
548}
549
91bde4a0
HSHR
550MAIN: {
551
525c441c
HSHR
552 # some of these settings are useful only if we're in the
553 # exim-projekt-root, but the check, if we're, is deferred
554 my $context = Context->new(
be914e6c 555 pkgname => 'exim',
525c441c 556 website_base => abs_path('../exim-website'),
9d0311ff 557 tar_cmd => 'tar',
45b75b0a
PP
558 tar_perms => {
559 user => '0',
560 group => '0',
561 },
cbae9e74 562 make_cmd => 'make', # for 'make'ing the docs
f8d3457b 563 sizes => 1,
9d0311ff 564 compressors => {
b3fadca5 565 gzip => { use => 1, extension => 'gz', flags => compressor('gzip -9', sub { $ENV{GZIP} = '-9'; '--gzip' }) },
00eda5ea 566 bzip2 => { use => 1, extension => 'bz2', flags => compressor('bzip2 -9', sub { $ENV{BZIP2} = '-9'; '--bzip2' }) },
b3fadca5
HSHR
567 xz => { use => 1, extension => 'xz', flags => compressor('xz -9', sub { $ENV{XZ_OPT} = '-9'; '--xz' }) },
568 lzip => { use => 0, extension => 'lz', flags => compressor('lzip -9', '--lzip') },
9d0311ff 569 },
525c441c 570 docs => 1,
2820726f 571 web => 1,
525c441c
HSHR
572 delete => 0,
573 cleanup => 1,
162e16b1
HSHR
574 gpg => {
575 sign => 1,
576 key => undef,
577 },
cbae9e74 578 quick => 0,
525c441c
HSHR
579 );
580
8f29c950 581 ##$ENV{'PATH'} = '/opt/local/bin:' . $ENV{'PATH'};
8a483da6 582
91bde4a0 583 GetOptions(
525c441c 584 $context,
cbae9e74 585 qw(workspace|tmp=s website_base|webgen_base=s tar_cmd|tar-cmd=s make_cmd|make-cmd=s
f8d3457b 586 docs|build-docs! web|build-web! sizes!
cbae9e74 587 delete! cleanup! quick|quick-release! minimal),
162e16b1
HSHR
588 'sign!' => \$context->{gpg}{sign},
589 'key=s' => \$context->{gpg}{key},
91bde4a0 590 'verbose!' => \$verbose,
ab1aa32a
HSHR
591 'compressors=s@' => sub {
592 die "$0: can't parse compressors string `$_[1]'\n" unless $_[1] =~ /^[+=-]?\w+(?:[+=-]\w+)*$/;
593 while ($_[1] =~ /(?<act>[+=-])?(?<name>\w+)\b/g) {
594 die "$0: Unknown compressor $+{name}"
595 unless $context->{compressors}{$+{name}};
596 if (not defined $+{act} or $+{act} eq '=') {
597 $_->{use} = 0
598 for values %{$context->{compressors}};
599 $context->{compressors}{$+{name}}{use}++;
600 }
601 elsif ($+{act} eq '+') { $context->{compressors}{$+{name}}{use}++; }
602 elsif ($+{act} eq '-') { $context->{compressors}{$+{name}}{use}--; }
603 }
604 },
cbae9e74
HSHR
605 'debug:s' => \$debug,
606 'quick' => sub { $context->{web}--; $context->{quick} = 1 },
91bde4a0
HSHR
607 'help|?' => sub { pod2usage(-verbose => 1, -exit => 0) },
608 'man!' => sub { pod2usage(-verbose => 2, -exit => 0, -noperldoc => system('perldoc -V >/dev/null 2>&1')) },
cbae9e74
HSHR
609 ) and (@ARGV == 2 or ($context->{quick} and @ARGV >= 1))
610 or pod2usage;
525c441c 611
162e16b1
HSHR
612 -f '.exim-project-root'
613 or die "$ME: please call this script from the root of the Exim project sources\n";
525c441c
HSHR
614
615 $context->{OUTDIR} = pop @ARGV;
616
162e16b1
HSHR
617 if ($context->{gpg}{sign}) {
618 $context->{gpg}{key} //= do { chomp($_ = qx/git config user.signingkey/); $_ }
619 || $ENV{EXIM_KEY}
620 || do {
621 warn "$ME: No GPG key, using default\n";
622 undef;
623 }
624 }
625
525c441c
HSHR
626
627 warn "$ME: changed umask to 022\n" if umask(022) != 022;
628
cbae9e74
HSHR
629 $context->check_version(shift); # may be undef for a quick release
630
631 if ($debug//'' eq 'version') {
632 for (sort keys %{$context->{v}}) {
633 print "version $_: $context->{v}{$_}\n";
634 }
635 print "git commit: $context->{commit}\n";
636 exit 0;
637 }
525c441c
HSHR
638 $context->override_tar_cmd;
639 $context->prepare_working_directory;
640 $context->export_git_tree;
641 $context->unpack_tree;
642 $context->make_version_script;
cbae9e74 643
525c441c 644 $context->build_documentation if $context->{docs};
51420ec3 645 $context->build_html_documentation if $context->{docs} && $context->{web};
525c441c
HSHR
646
647 $context->build_src_package_directory;
648 $context->build_doc_packages_directory if $context->{docs};
649
650 $context->create_tar_files;
162e16b1 651 $context->sign if $context->{gpg}{sign};
525c441c
HSHR
652 $context->move_to_outdir;
653 $context->do_cleanup if $context->{cleanup};
654
655 ### $context
8a483da6
NM
656}
657
6581;
659
660__END__
661
662=head1 NAME
663
6bfa380e 664mk_exim_release - Build an exim release
8a483da6
NM
665
666=head1 SYNOPSIS
667
525c441c 668 mk_exim_release [options] version PKG-DIRECTORY
cbae9e74 669 mk_exim_release [options] --quick [version] PKG-DIRECTORY
91bde4a0
HSHR
670
671=head1 DESCRIPTION
672
673B<mk_exim_release> builds an exim release.
674
675Starting in a populated git repo that has already been tagged for
676release it builds docs, packages etc. Parameter is the version number
525c441c
HSHR
677to build as - ie 4.72 4.72-RC1, 4.86.1, etc, without any prefix.
678
679This scripts expects to find a tag "exim-<version>".
91bde4a0
HSHR
680
681After creating the release files, they should be signed. There is another
682helper for creating the signatures:
683F<release-process/scripts/sign_exim_packages>.
684
685Call B<mk_exim_release> about like this:
686
525c441c 687 release-process/scripts/mk_exim_release 4.99 OUT-DIR
8a483da6 688
8a483da6
NM
689
690=head1 OPTIONS
691
692=over 4
693
525c441c
HSHR
694=item B<--[no]cleanup>
695
696Do (or do not) cleanup the tmp directory at exit (default: do cleanup)
697
ab1aa32a
HSHR
698=item B<--compressors> [I<action>]I<compressor[I<action>$<compressor>]...
699
700A list of compressors to use. Currently the default list is
701B<gzip>, B<xz>, and B<bzip2>, with B<lzip> optionally to be enabled.
702
703I<action> can be "+" (add), "-" (remove), and "=" (set).
704
cbae9e74
HSHR
705=item B<--debug[=I<item>]>
706
707Forces debug mode. If (default: no debug info)
708
709=over 4
710
711=item item: B<version>
712
713Output the parsed/found version number and exit.
8a483da6 714
cbae9e74 715=back
8a483da6 716
91bde4a0 717=item B<--[no]delete>
9d0311ff 718
525c441c 719Delete a pre-existing tmp- and package-directory at start. (default: don't delete)
9d0311ff 720
cbae9e74 721=item B<--[no]doc>
a7637438 722
cbae9e74 723Do (not) build the documentation. This needs C<gnu-make> (default: build the docs)
a7637438 724
91bde4a0 725=item B<--[no]help>
9d0311ff 726
91bde4a0 727Display short help and exit cleanly. (default: don't do that)
9d0311ff 728
cbae9e74
HSHR
729=item B<--key> I<GPG key>
730
731Use this GPG key for signing. If nothing is specified the first one of this list
732is used:
733
734=over 8
735
736=item - git config user.signingkey
737
738=item - environment C<EXIM_KEY>
739
740=item - default GPG key
741
742=back
743
cbae9e74 744=item B<--make-cmd> I<cmd>
8a483da6 745
91bde4a0 746Force the use of a specific C<make> command. This may be necessary if C<make> is not
cbae9e74 747C<gmake>. This is necessary to build the docs. (default: C<make>)
8a483da6 748
91bde4a0 749=item B<--[no]man>
8a483da6 750
91bde4a0 751Display man page and exit cleanly. (default: don't do that)
8a483da6 752
cbae9e74 753=item B<--quick>
8a483da6 754
cbae9e74
HSHR
755Create a quick release. The I<version> mandatory argument needs to be a git commit-ish.
756(try I<master> or I<HEAD> or similar). This mode switches off the
757website creation (which can be enabled by B<--web> again).
8a483da6 758
162e16b1
HSHR
759=item B<--[no]sign>
760
761Sign the created archive files (and the sizes.txt). (default: sign)
762
f8d3457b
HSHR
763=item B<--[no]sizes>
764
765Write the sizes information to F<sizes.txt>. (default: write sizes)
766
cbae9e74 767=item B<--tar-cmd> I<cmd>
162e16b1 768
cbae9e74 769Use to override the path to the C<tar> command. Need GNU tar in case
b3fadca5 770I<lzip> is selected. (default: C<gtar>, if not found, use C<tar>).
162e16b1 771
cbae9e74 772=item B<--tmpdir> I<dir>
162e16b1 773
cbae9e74 774Change the name of the tmp directory (default: temporary directory)
162e16b1 775
cbae9e74 776=item B<--verbose>
162e16b1 777
cbae9e74 778Force verbose mode. (default: no verbosity)
162e16b1 779
91bde4a0 780=item B<--[no]web>
8a483da6 781
91bde4a0 782Control the creation of the website. For creation of the website, the F<../exim-website>
cbae9e74
HSHR
783(but see the B<website-base> option) directory must exist. (default: create the website, except when
784in B<quick> mode)
525c441c
HSHR
785
786=item B<--website-base> I<dir>
787
788Base directory for the web site generation (default: F<../exim-website>)
8a483da6 789
cbae9e74 790=item B<-workspace>|B<--tmp> I<directory>
91bde4a0 791
cbae9e74
HSHR
792During release gerneration temporary storage is necessary. (default: F<exim-packaging-XXXX>
793under your system's default temporary directory (typically this is F</tmp>)).
91bde4a0
HSHR
794
795=back
8a483da6
NM
796
797=head1 AUTHOR
798
91bde4a0
HSHR
799Nigel Metheringham <Nigel.Metheringham@dev.intechnology.co.uk>,
800some changes by Heiko Schlittermann <hs@schlittermann.de>
8a483da6
NM
801
802=head1 COPYRIGHT
803
91bde4a0 804Copyright 2010-2016 Exim Maintainers. All rights reserved.
8a483da6
NM
805
806=cut
9d0311ff 807# vim: set sw=4 et :