release-process/scripts/mk_exim_release

   1 #!/usr/bin/env perl
   2 # Copyright (c) The Exim Maintainers 2016-2018
   3
   4 use strict;
   5 use warnings;
   6 use Carp;
   7 use Cwd qw'abs_path';
   8 use File::Basename;
   9 use File::Path qw(make_path remove_tree);
  10 use File::Temp;
  11 use Getopt::Long;
  12 use IO::File;
  13 use Pod::Usage;
  14 use Digest::SHA;
  15 use feature 'state';
  16 use if $ENV{DEBUG} => 'Smart::Comments';
  17
  18 my $ME = basename $0;
  19
  20
  21 my $debug   = undef;
  22 my $verbose = 0;
  23
  24 # MAJOR.MINOR[.SECURITY[.FIXES]][-RCX]
  25 # 4    .90    .0        .22      -RC1
  26 my $version_pattern = qr/
  27     (?<release>
  28     (?<target_release>
  29            (?<major>\d)         # 4
  30          \.(?<minor>\d\d)       #  .90
  31       (?:\.(?<security>\d+)     #     .0
  32       (?:\.(?<fixes>)\d+)?)?    #       .22
  33     )                           # target-release ->|
  34        (?:-(?<rc>RC\d+)?)?      #          -RC1
  35     )
  36 /x;
  37
  38 my $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
  50 # ------------------------------------------------------------------
  51
  52 package 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 }
  65     }
  66
  67     tie my $cwd => 'PWD' or die;    # this returns the current dir now, dynamically
  68
  69     sub new {
  70         my $class = shift;
  71         return bless { @_ } => $class;
  72     }
  73
  74     sub check_version {
  75         my $context = shift;
  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
  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
 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'});
 124
 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;
 127
 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         }
 132
 133         die "$ME: This script doesn't work for versions prior 4.92-RCx. "
 134            ."Please checkout an older version.\n"
 135             if $context->{v}{major} < 4
 136             or $context->{v}{major} == 4 && $context->{v}{minor} < 92;
 137
 138         ### v: $context->{v}
 139
 140     }
 141
 142
 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};
 147
 148         return unless $tar eq 'tar';
 149
 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     }
 159
 160     sub prepare_working_directory {
 161         my $context = shift;
 162         my $workspace = $context->{workspace};
 163
 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         }
 182
 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     }
 190
 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
 197         my @cmd = ( 'git', 'archive', '--format=tar', "--output=$archive_file", $context->{commit} );
 198         ### @cmd
 199         # run git command
 200         print "[$cwd] Running: @cmd\n" if $verbose;
 201         0 == system @cmd or croak "Export failed";
 202     }
 203
 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;
 208
 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} );
 214
 215         # run  command
 216         print "[$cwd] Running: @cmd\n" if $verbose;
 217         system @cmd and croak "Unpack failed\n";
 218
 219     }
 220
 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
 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};
 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                 : '';
 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
 271 EXIM_RELEASE_VERSION=$release
 272 EXIM_VARIANT_VERSION=$variant
 273 EXIM_COMPILE_NUMBER=0
 274 # echo "[[[ \$EXIM_RELEASE_VERSION | \$EXIM_VARIANT_VERSION | \$EXIM_COMPILE_NUMBER ]]]"
 275 __
 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';
 279
 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.
 282             #my @cmd = ('../scripts/reversion', 'release', $context->{commit});
 283
 284             my @cmd = ('../scripts/reversion', 'release');
 285             print "[$cwd] Running: @cmd\n" if $verbose;
 286             system(@cmd) and croak "reversion failed";
 287
 288             die "$ME: failed to create version.sh"
 289                 unless -f 'version.sh';
 290
 291             exit 0;
 292         }
 293         else {
 294             $pid == waitpid($pid, 0) or die "$0: waidpid: $!\n";
 295             exit $? >> 8 if $?;
 296         }
 297     }
 298
 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},
 309                 "EXIM_VER=$context->{v}{release}", 'everything'
 310                 or die "$ME: [$cwd] Cannot exec $context->{make_cmd}: $!\n";
 311         }
 312         else {
 313             waitpid($pid, 0);
 314             exit $? >> 8 if $?;
 315         }
 316
 317         $context->copy_docbook_files;
 318     }
 319
 320     sub copy_docbook_files {
 321         my $context = shift;
 322
 323         # where the generated docbook files can be found
 324         my $docdir = catdir $context->{d}{vcs_export}, 'doc', 'doc-docbook';
 325
 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     }
 332
 333     sub build_html_documentation {
 334         my $context = shift;
 335
 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};
 340             make_path $webdir, { verbose => $verbose || $debug };
 341             copy catfile($context->{d}{vcs_export}, 'doc', 'doc-docbook', $_)
 342                 => $webdir or die $@
 343                 for 'spec.xml', 'filter.xml';
 344         }
 345
 346         my $gen    = catfile $context->{website_base}, 'script/gen';
 347         my $outdir = catdir $context->{d}{pkg_trees}, "exim-html-$context->{v}{release}";
 348
 349         make_path $outdir, { verbose => $verbose || $debug };
 350
 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         );
 360
 361         print "[$cwd] Executing @cmd\n";
 362         0 == system @cmd or exit $? >> 8;
 363
 364     }
 365
 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
 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     }
 384
 385     sub build_src_package_directory {
 386         my $context = shift;
 387
 388         # build the exim package directory path
 389         $context->{d}{src} = catdir $context->{d}{pkg_trees}, "exim-$context->{v}{release}";
 390
 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 - $!";
 396
 397         # add Local subdirectory
 398         make_path( catdir( $context->{d}{src}, 'Local' ), { verbose => $verbose || $debug } );
 399
 400         # now add the text docs
 401         $context->move_text_docs_into_pkg;
 402     }
 403
 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                         )
 424                     )
 425                 )
 426             )
 427             {
 428                 move( $file, catfile( $target, ( splitpath($file) )[2] ) );
 429             }
 430         }
 431     }
 432
 433     sub move_text_docs_into_pkg {
 434         my $context = shift;
 435
 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 } );
 440
 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         }
 446
 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 ) );
 461         }
 462     }
 463
 464     sub create_tar_files {
 465         my $context = shift;
 466
 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         }
 475
 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.
 480         my @ownership = (
 481             '--owner' => $context->{tar_perms}{user},
 482             '--group' => $context->{tar_perms}{group},
 483             # on this GNU tar, --numeric-owner works during creation too
 484             '--numeric-owner'
 485         ) if qx/tar --help 2>&1/ =~ /^\s*--owner=/m;
 486
 487         # See also environment variables set in main, tuning compression levels
 488
 489         my (%size, %sha256);
 490
 491         foreach my $dir ( glob( catdir( $pkg_trees, ( 'exim*-' . $context->{v}{release} ) ) ) ) {
 492             my $dirname = ( splitdir($dir) )[-1];
 493             foreach my $comp (keys %{$context->{compressors}}) {
 494                 my %compressor = %{$context->{compressors}{$comp}};
 495                 next unless $compressor{use};
 496
 497                 my $basename = "$dirname.tar.$compressor{extension}";
 498                 my $outfile = catfile $pkg_tars, $basename;
 499
 500                 print "Creating: $outfile\n" if $verbose || $debug;
 501                 0 == system($tar,
 502                     cf => $outfile,
 503                         $compressor{flags},
 504                         @ownership, -C => $pkg_trees, $dirname)
 505                     or exit $? >> 8;
 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                 };
 514             }
 515         }
 516
 517         # write the sizes file
 518         if ($context->{sizes}) {
 519             open my $sizes, '>', $_ = catfile $pkg_tars, 'sizes.txt'
 520                 or die "$ME: Can't open `$_': $!\n";
 521
 522             print $sizes join "\n",
 523                 (map { "SIZE($_) = $size{$_}" } sort keys %size),
 524                 (map { "SHA256($_) = $sha256{$_}" } sort keys %sha256);
 525
 526             close($sizes) or die "$ME: Can't close $_: $!\n";
 527         }
 528     }
 529
 530     sub do_cleanup {
 531         my $context = shift;
 532
 533         print "Cleaning up\n" if $verbose;
 534         remove_tree $context->{d}{tmp}, { verbose => $verbose || $debug };
 535     }
 536
 537 }
 538
 539 # Check, if tar understands --use-compress-program and use this, as
 540 # at least gzip deprecated passing options via the environment.
 541 sub 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
 550 MAIN: {
 551
 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(
 555         pkgname     => 'exim',
 556         website_base => abs_path('../exim-website'),
 557         tar_cmd     => 'tar',
 558         tar_perms   => {
 559                 user    => '0',
 560                 group   => '0',
 561         },
 562         make_cmd    => 'make',  # for 'make'ing the docs
 563         sizes       => 1,
 564         compressors => {
 565             gzip  => { use => 1, extension => 'gz',  flags => compressor('gzip -9', sub { $ENV{GZIP} = '-9'; '--gzip' }) },
 566             bzip2 => { use => 1, extension => 'bz2', flags => compressor('bzip -9', sub { $ENV{BZIP2} = '-9'; '--bzip2' }) },
 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') },
 569         },
 570         docs         => 1,
 571         web          => 1,
 572         delete       => 0,
 573         cleanup      => 1,
 574         gpg => {
 575             sign         => 1,
 576             key          => undef,
 577         },
 578         quick => 0,
 579     );
 580
 581     ##$ENV{'PATH'} = '/opt/local/bin:' . $ENV{'PATH'};
 582
 583     GetOptions(
 584         $context,
 585         qw(workspace|tmp=s website_base|webgen_base=s tar_cmd|tar-cmd=s make_cmd|make-cmd=s
 586            docs|build-docs! web|build-web! sizes!
 587            delete! cleanup! quick|quick-release! minimal),
 588         'sign!'         => \$context->{gpg}{sign},
 589         'key=s'         => \$context->{gpg}{key},
 590         'verbose!'      => \$verbose,
 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         },
 605         'debug:s'       => \$debug,
 606         'quick'         => sub { $context->{web}--; $context->{quick} = 1 },
 607         'help|?'        => sub { pod2usage(-verbose => 1, -exit => 0) },
 608         'man!'          => sub { pod2usage(-verbose => 2, -exit => 0, -noperldoc => system('perldoc -V >/dev/null 2>&1')) },
 609     ) and (@ARGV == 2 or ($context->{quick} and @ARGV >= 1))
 610         or pod2usage;
 611
 612     -f '.exim-project-root'
 613         or die "$ME: please call this script from the root of the Exim project sources\n";
 614
 615     $context->{OUTDIR} = pop @ARGV;
 616
 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
 626
 627     warn "$ME: changed umask to 022\n" if umask(022) != 022;
 628
 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     }
 638     $context->override_tar_cmd;
 639     $context->prepare_working_directory;
 640     $context->export_git_tree;
 641     $context->unpack_tree;
 642     $context->make_version_script;
 643
 644     $context->build_documentation if $context->{docs};
 645     $context->build_html_documentation if $context->{docs} && $context->{web};
 646
 647     $context->build_src_package_directory;
 648     $context->build_doc_packages_directory if $context->{docs};
 649
 650     $context->create_tar_files;
 651     $context->sign if $context->{gpg}{sign};
 652     $context->move_to_outdir;
 653     $context->do_cleanup if $context->{cleanup};
 654
 655     ### $context
 656 }
 657
 658 1;
 659
 660 __END__
 661
 662 =head1 NAME
 663
 664 mk_exim_release - Build an exim release
 665
 666 =head1 SYNOPSIS
 667
 668  mk_exim_release [options] version PKG-DIRECTORY
 669  mk_exim_release [options] --quick [version] PKG-DIRECTORY
 670
 671 =head1 DESCRIPTION
 672
 673 B<mk_exim_release> builds an exim release.
 674
 675 Starting in a populated git repo that has already been tagged for
 676 release it builds docs, packages etc.  Parameter is the version number
 677 to build as - ie 4.72 4.72-RC1, 4.86.1, etc, without any prefix.
 678
 679 This scripts expects to find a tag "exim-<version>".
 680
 681 After creating the release files, they should be signed. There is another
 682 helper for creating the signatures:
 683 F<release-process/scripts/sign_exim_packages>.
 684
 685 Call B<mk_exim_release> about like this:
 686
 687     release-process/scripts/mk_exim_release 4.99 OUT-DIR
 688
 689
 690 =head1 OPTIONS
 691
 692 =over 4
 693
 694 =item B<--[no]cleanup>
 695
 696 Do (or do not) cleanup the tmp directory at exit (default: do cleanup)
 697
 698 =item B<--compressors> [I<action>]I<compressor[I<action>$<compressor>]...
 699
 700 A list of compressors to use. Currently the default list is
 701 B<gzip>, B<xz>, and B<bzip2>, with B<lzip> optionally to be enabled.
 702
 703 I<action> can be "+" (add), "-" (remove), and "=" (set).
 704
 705 =item B<--debug[=I<item>]>
 706
 707 Forces debug mode. If (default: no debug info)
 708
 709 =over 4
 710
 711 =item item: B<version>
 712
 713 Output the parsed/found version number and exit.
 714
 715 =back
 716
 717 =item B<--[no]delete>
 718
 719 Delete a pre-existing tmp- and package-directory at start. (default: don't delete)
 720
 721 =item B<--[no]doc>
 722
 723 Do (not) build the documentation. This needs C<gnu-make> (default: build the docs)
 724
 725 =item B<--[no]help>
 726
 727 Display short help and exit cleanly. (default: don't do that)
 728
 729 =item B<--key> I<GPG key>
 730
 731 Use this GPG key for signing. If nothing is specified the first one of this list
 732 is 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
 744 =item B<--make-cmd> I<cmd>
 745
 746 Force the use of a specific C<make> command. This may be necessary if C<make> is not
 747 C<gmake>. This is necessary to build the docs. (default: C<make>)
 748
 749 =item B<--[no]man>
 750
 751 Display man page and exit cleanly. (default: don't do that)
 752
 753 =item B<--quick>
 754
 755 Create 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
 757 website creation (which can be enabled by B<--web> again).
 758
 759 =item B<--[no]sign>
 760
 761 Sign the created archive files (and the sizes.txt). (default: sign)
 762
 763 =item B<--[no]sizes>
 764
 765 Write the sizes information to F<sizes.txt>. (default: write sizes)
 766
 767 =item B<--tar-cmd> I<cmd>
 768
 769 Use to override the path to the C<tar> command.  Need GNU tar in case
 770 I<lzip> is selected. (default: C<gtar>, if not found, use C<tar>).
 771
 772 =item B<--tmpdir> I<dir>
 773
 774 Change the name of the tmp directory (default: temporary directory)
 775
 776 =item B<--verbose>
 777
 778 Force verbose mode. (default: no verbosity)
 779
 780 =item B<--[no]web>
 781
 782 Control the creation of the website. For creation of the website, the F<../exim-website>
 783 (but see the B<website-base> option) directory must exist. (default: create the website, except when
 784 in B<quick> mode)
 785
 786 =item B<--website-base> I<dir>
 787
 788 Base directory for the web site generation (default: F<../exim-website>)
 789
 790 =item B<-workspace>|B<--tmp> I<directory>
 791
 792 During release gerneration temporary storage is necessary. (default: F<exim-packaging-XXXX>
 793 under your system's default temporary directory (typically this is F</tmp>)).
 794
 795 =back
 796
 797 =head1 AUTHOR
 798
 799 Nigel Metheringham <Nigel.Metheringham@dev.intechnology.co.uk>,
 800 some changes by Heiko Schlittermann <hs@schlittermann.de>
 801
 802 =head1 COPYRIGHT
 803
 804 Copyright 2010-2016 Exim Maintainers. All rights reserved.
 805
 806 =cut
 807 # vim: set sw=4 et :