2 # Copyright (c) The Exim Maintainers 2016-2018
9 use File::Path qw(make_path remove_tree);
15 use if $ENV{DEBUG} => 'Smart::Comments';
23 # MAJOR.MINOR[.SECURITY[.FIXES]][-RCX]
25 my $version_pattern = qr/
28 \.(?<minor>\d\d) # .90
29 (?:\.(?<security>\d+) # .0
30 (?:\.(?<fixes>)\d+)?)? # .22
31 (?:-(?<rc>RC\d+)?)? # -RC1
35 # ------------------------------------------------------------------
38 use strict; # not strictly necessary yet, until in an own package
39 use warnings; # not strictly necessary yet, ...
40 use File::Spec::Functions qw'splitpath catfile catdir splitdir';
41 use File::Path qw'make_path remove_tree';
48 sub TIESCALAR { bless do {\my $x} }
52 tie my $cwd => 'PWD' or die;
56 return bless { @_ } => $class;
63 croak "The given version number does not look right - $version"
64 if not $version =~ /$version_pattern/;
66 $context->{v}{release} = $+{release};
67 $context->{v}{major} = $+{major};
68 $context->{v}{minor} = $+{minor};
69 $context->{v}{security} = $+{security};
70 $context->{v}{rc} = $+{rc};
72 die "$ME: This script doesn't work for versions prior 4.92-RCx. Please checkout an older version.\n"
73 if $context->{v}{major} < 4
74 or $context->{v}{major} == 4 && $context->{v}{minor} < 92;
78 # find a valid vcs tag matching the version
79 my $pattern = "$context->{pkgname}-$context->{v}{release}" =~ s/[-_.]/[-_.]/gr;
80 chomp(my @tags = qx{git tag --list '$pattern'});
82 croak "The given version is ambigous, tags: @tags\n" if @tags > 1;
83 croak "The given version does not exist (no such tag: exim-$version)\n" if @tags == 0;
85 $context->{git_tag} = $tags[0];
87 # target_release: the release we aim to reach with release candidates
88 # FIXME: re-construct from the parsed version number
89 ($context->{v}{target_release} = $context->{v}{release}) =~ s/-RC\d+//;
93 # We prefer gtar to tar if gtar exists in $PATH
94 sub override_tar_cmd {
96 my $tar = $context->{tar_cmd};
98 return unless $tar eq 'tar';
100 foreach my $d (File::Spec->path()) {
101 my $p = catfile($d, 'gtar');
103 $context->{tar_cmd} = $p;
104 print "Switched tar command to: $p\n" if $verbose;
110 sub prepare_working_directory {
112 my $workspace = $context->{workspace};
114 if (not defined $workspace) {
115 $workspace = $context->{workspace} = File::Temp->newdir(File::Spec->tmpdir . '/exim-packaging-XXXX');
118 # ensure the working directory is not in place
120 if ($context->{delete}) {
121 print "Deleting existing $workspace\n" if $verbose;
122 remove_tree $workspace, { verbose => $verbose || $debug };
125 croak "Working directory $workspace exists" if -e $workspace;
129 # create base directory
130 make_path( $context->{directory}, { verbose => $verbose || $debug } );
133 # Set(!) and create subdirectories
134 foreach (qw(vcs_export pkg_tars pkg_trees tmp)) { # {dookbook}
136 $context->{d}{$_} = catdir($workspace, $_),
137 { verbose => $verbose || $debug });
141 sub export_git_tree {
145 my $archive_file = $context->{tmp_archive_file} = sprintf'%s/%s-%s.tar', $context->{d}{tmp}, $context->{pkgname}, $context->{v}{release};
147 my @cmd = ( 'git', 'archive', '--format=tar', "--output=$archive_file", $context->{git_tag} );
150 print "[$cwd] Running: @cmd\n" if $verbose;
151 0 == system @cmd or croak "Export failed";
155 # TODO: Why can't we combine the export_git_tree with the
156 # unpack_tree function?
160 die "Cannot see archive file\n" unless -f $context->{tmp_archive_file};
162 xf => $context->{tmp_archive_file},
163 -C => $context->{d}{vcs_export} );
166 print "[$cwd] Running: @cmd\n" if $verbose;
167 system @cmd and croak "Unpack failed\n";
171 sub make_version_script {
174 #my $variant = substr( $context->{v}{release}, length($context->{v}{target_release}) );
175 #if ( $context->{v}{release} ne $context->{v}{target_release} . $variant ) {
176 # die "Broken version numbering, I'm buggy";
181 if (not my $pid = fork // die "$ME: Cannot fork: $!\n") {
183 my $source_tree = catdir($context->{d}{vcs_export}, 'src', 'src');
186 chdir $source_tree or die "chdir $source_tree: $!\n";
189 croak "WARNING: version.sh already exists - leaving it in place\n"
192 # Currently (25. Feb. 2016) the mk_exim_release.pl up to now can't
193 # deal with security releases.!? So we need a current
194 # mk_exim_release.pl. But if we use a current (master), the
195 # reversion script returns wrong version info (it's running inside
196 # the Git tree and uses git --describe, which always returns the
197 # current version of master.) I do not want to change the old
198 # reversion scripts (in 4.86.1, 4.85.1).
200 # Thus we've to provide the version.sh, based on the info we have
201 # about the release. If reversion finds this, it doesn't try to find
202 # it's own way to get a valid version number from the git.
204 # 4.89 series: the logic here did not handle _RC<N> thus breaking RC
205 # status in versions. nb: rc in context should be same as $variant
208 #my $stamp = $context->{minor} ? '_'.$context->{minor} : '';
209 #$stamp .= $context->{rc} if $context->{rc};
210 my $variant = $context->{v}{rc} // '';
212 print "[$cwd] create version.sh\n" if $verbose;
213 open(my $v, '>', 'version.sh') or die "Can't open version.sh for writing: $!\n";
215 # initial version automatically generated by $0
216 EXIM_RELEASE_VERSION=$context->{v}{target_release}
217 EXIM_VARIANT_VERSION=$variant
218 EXIM_COMPILE_NUMBER=0
219 # echo "[[[ \$EXIM_RELEASE_VERSION | \$EXIM_VARIANT_VERSION | \$EXIM_COMPILE_NUMBER ]]]"
221 close $v or die "$0: Can not close $source_tree/version.h: $!\n";
222 unlink 'version.h' or die "$ME: Can not unlink $source_tree/version.h: $!\n"
225 # Later, if we get the reversion script fixed, we can call it again.
226 # For now (25. Feb. 2016) we'll leave it unused.
227 #my @cmd = ('../scripts/reversion', 'release', $context->{git_tag});
229 my @cmd = ('../scripts/reversion', 'release');
230 print "[$cwd] Running: @cmd\n" if $verbose;
231 system(@cmd) and croak "reversion failed";
233 die "$ME: failed to create version.sh"
234 unless -f 'version.sh';
239 $pid == waitpid($pid, 0) or die "$0: waidpid: $!\n";
244 sub build_documentation {
246 my $docdir = catdir $context->{d}{vcs_export}, 'doc', 'doc-docbook';
248 # documentation building does a chdir, so we'll do it in a
250 if (not my $pid = fork // die "$ME: Can't fork: $!\n") {
251 chdir $docdir or die "$ME: Can't chdir to $docdir: $!\n";
252 system('./OS-Fixups') == 0 or exit $?;
253 exec $context->{make_cmd},
254 "EXIM_VER=$context->{v}{target_release}" .
255 ($context->{v}{rc} ? "-$context->{v}{rc}" : ''),
257 die "$ME: [$cwd] Cannot exec $context->{make_cmd}: $!\n";
264 $context->copy_docbook_files;
265 $context->build_html_documentation if $context->{web};
268 sub copy_docbook_files {
271 # where the generated docbook files can be found
272 my $docdir = catdir $context->{d}{vcs_export}, 'doc', 'doc-docbook';
274 foreach ('spec.xml', 'filter.xml') {
275 my $from = catfile $docdir, $_;
276 my $to = catdir $context->{d}{tmp}; # {dookbook}
277 copy $from => $to or die $@;
281 sub build_html_documentation {
284 # where the website docbook source dir is - push the generated
287 my $webdir = catdir $context->{website_base}, 'docbook', $context->{v}{target_release};
288 make_path $webdir, { verbose => $verbose + $debug };
289 copy catfile($context->{d}{vcs_export}, 'doc', 'doc-docbook', $_)
291 for 'spec.xml', 'filter.xml';
294 my $gen = catfile $context->{website_base}, 'script/gen';
295 my $outdir = catdir $context->{d}{pkg_trees}, "exim-html-$context->{v}{release}";
297 make_path $outdir, { verbose => $verbose || $debug };
301 '--spec' => catfile($context->{d}{tmp}, 'spec.xml'), # {dookbook}
302 '--filter' => catfile($context->{d}{tmp}, 'filter.xml'), # {dookbok}
303 '--latest' => $context->{v}{target_release},
304 '--docroot' => $outdir,
306 ($verbose || $debug ? '--verbose' : ()),
309 print "[$cwd] Executing @cmd\n";
310 0 == system @cmd or exit $? >> 8;
316 foreach my $tar (glob "$context->{d}{pkg_tars}/*") {
318 '--quiet', '--batch',
319 defined $context->{gpg}{key}
320 ? ('--local-user' => $context->{gpg}{key})
322 '--detach-sig', '--armor', $tar;
328 make_path $context->{OUTDIR}, { verbose => $verbose || $debug };
329 move $_ => $context->{OUTDIR} or die $@
330 for glob "$context->{d}{pkg_tars}/*";
333 sub build_src_package_directory {
336 # build the exim package directory path
337 $context->{d}{src} = catdir $context->{d}{pkg_trees}, "exim-$context->{v}{release}";
339 # initially we move the exim-src directory to the new directory name
341 catdir( $context->{d}{vcs_export}, 'src')
342 => $context->{d}{src}
343 or croak "Move of src dir failed - $!";
345 # add Local subdirectory
346 make_path( catdir( $context->{d}{src}, 'Local' ), { verbose => $verbose || $debug } );
348 # now add the text docs
349 $context->move_text_docs_into_pkg;
352 sub build_doc_packages_directory {
355 ##foreach my $format (qw/pdf postscript texinfo info/) {
356 foreach my $format (qw/pdf postscript/) {
357 my $target = catdir $context->{d}{pkg_trees}, "exim-$format-$context->{v}{release}", 'doc';
358 make_path( $target, { verbose => $verbose || $debug } );
360 # move documents across
364 $context->{d}{vcs_export},
368 ( $format eq 'postscript' )
376 move( $file, catfile( $target, ( splitpath($file) )[2] ) );
381 sub move_text_docs_into_pkg {
384 my $old_docdir = catdir( $context->{d}{vcs_export}, 'doc', 'doc-docbook' );
385 my $old_txtdir = catdir( $context->{d}{vcs_export}, 'doc', 'doc-txt' );
386 my $new_docdir = catdir( $context->{d}{src}, 'doc' );
387 make_path( $new_docdir, { verbose => $verbose || $debug } );
389 # move generated documents from docbook stuff
390 foreach my $file (qw/exim.8 spec.txt filter.txt/) {
391 die "Empty file \"$file\"\n" if -z catfile( $old_docdir, $file );
392 move( catfile( $old_docdir, $file ), catfile( $new_docdir, $file ) );
395 # move text documents across
396 foreach my $file ( glob( catfile( $old_txtdir, '*' ) ) ) {
398 # skip a few we dont want
399 my $fn = ( splitpath($file) )[2];
401 if ( ( $fn eq 'ABOUT' )
402 || ( $fn eq 'ChangeLog.0' )
403 || ( $fn eq 'test-harness.txt' )
404 # Debian issue re licensing of RFCs
405 || ( $fn =~ /^draft-ietf-.*/ )
406 || ( $fn =~ /^rfc.*/ )
408 move( $file, catfile( $new_docdir, $fn ) );
412 sub create_tar_files {
415 my $pkg_tars = $context->{d}{pkg_tars};
416 my $pkg_trees = $context->{d}{pkg_trees};
417 my $tar = $context->{tar_cmd};
419 foreach my $c (keys %{ $context->{compressors} }) {
420 print "Compression: $c\t$context->{compressors}{$c}\n";
424 # We ideally do not want local system user information in release tarballs;
425 # those are artifacts of use of tar for backups and have no place in
426 # software release packaging; if someone extracts as root, then they should
427 # get sane file ownerships.
429 if (`tar --help 2>&1` =~ /^\s*--owner=/m) {
430 $ownership .= " --owner=$context->{tar_perms}{user} --group=$context->{tar_perms}{group}";
431 # on this GNU tar, --numeric-owner works during creation too
432 $ownership .= " --numeric-owner";
435 # See also environment variables set in main, tuning compression levels
437 # compressors-dict-key, file-extension, flags-as-string
438 [ "gzip", "gz", "--gzip" ],
439 [ "bzip2", "bz2", "--bzip2" ],
440 [ "lzip", "lz", "--lzip" ],
441 [ "xz", "xz", "--xz" ],
445 foreach my $dir ( glob( catdir( $pkg_trees, ( 'exim*-' . $context->{v}{release} ) ) ) ) {
446 my $dirname = ( splitdir($dir) )[-1];
447 foreach my $comp (@COMPRESSIONS) {
448 my ($compkey, $extension, $flags) = @{$comp};
449 next unless $context->{compressors}{$compkey};
451 my $basename = "$dirname.tar.$extension";
452 my $outfile = catfile $pkg_tars, $basename;
454 print "Creating: $outfile\n" if $verbose || $debug;
455 0 == system("$tar cf $outfile ${flags} ${ownership} -C ${pkg_trees} ${dirname}")
458 # calculate size and md5sum
459 $size{$basename} = -s $outfile;
460 $sha256{$basename} = do {
461 my $sha = Digest::SHA->new(256);
462 $sha->addfile($outfile);
468 # write the sizes file
469 open my $sizes, '>', $_ = catfile $pkg_tars, 'sizes.txt'
470 or die "$ME: Can't open `$_': $!\n";
471 print $sizes "SIZE($_) = $size{$_}\n" foreach sort keys %size;
473 print $sizes "SHA256($_) = $sha256{$_}\n" foreach sort keys %sha256;
474 close($sizes) or die "$ME: Can't close $_: $!\n";
480 print "Cleaning up\n" if $verbose;
481 remove_tree $context->{d}{tmp}, { verbose => $debug + $verbose };
488 # some of these settings are useful only if we're in the
489 # exim-projekt-root, but the check, if we're, is deferred
490 my $context = Context->new(
492 website_base => abs_path('../exim-website'),
515 ##$ENV{'PATH'} = '/opt/local/bin:' . $ENV{'PATH'};
516 # We are creating files for mass distribution, so work harder to make smaller files.
519 # xz documents minimum file sizes for levels higher than -6 to be useful and each
520 # requires more RAM on the decompressing system. Exim tarball currently 24MiB so
522 $ENV{XZ_DEFAULTS} = -8;
526 qw(workspace|tmp=s outdir=s website_base|webgen_base=s tar_cmd=s make_cmd=s docs|build-docs! web|build-web!
528 'sign!' => \$context->{gpg}{sign},
529 'key=s' => \$context->{gpg}{key},
530 'lzip!' => \$context->{compressors}{lzip},
531 'verbose!' => \$verbose,
533 'help|?' => sub { pod2usage(-verbose => 1, -exit => 0) },
534 'man!' => sub { pod2usage(-verbose => 2, -exit => 0, -noperldoc => system('perldoc -V >/dev/null 2>&1')) },
535 ) and @ARGV == 2 or pod2usage;
537 -f '.exim-project-root'
538 or die "$ME: please call this script from the root of the Exim project sources\n";
540 $context->{OUTDIR} = pop @ARGV;
542 if ($context->{gpg}{sign}) {
543 $context->{gpg}{key} //= do { chomp($_ = qx/git config user.signingkey/); $_ }
546 warn "$ME: No GPG key, using default\n";
552 warn "$ME: changed umask to 022\n" if umask(022) != 022;
554 $context->check_version(shift);
555 $context->override_tar_cmd;
556 $context->prepare_working_directory;
557 $context->export_git_tree;
558 $context->unpack_tree;
559 $context->make_version_script;
560 $context->build_documentation if $context->{docs};
562 $context->build_src_package_directory;
563 $context->build_doc_packages_directory if $context->{docs};
565 $context->create_tar_files;
566 $context->sign if $context->{gpg}{sign};
567 $context->move_to_outdir;
568 $context->do_cleanup if $context->{cleanup};
579 mk_exim_release - Build an exim release
583 mk_exim_release [options] version PKG-DIRECTORY
587 B<mk_exim_release> builds an exim release.
589 Starting in a populated git repo that has already been tagged for
590 release it builds docs, packages etc. Parameter is the version number
591 to build as - ie 4.72 4.72-RC1, 4.86.1, etc, without any prefix.
593 This scripts expects to find a tag "exim-<version>".
595 After creating the release files, they should be signed. There is another
596 helper for creating the signatures:
597 F<release-process/scripts/sign_exim_packages>.
599 Call B<mk_exim_release> about like this:
601 release-process/scripts/mk_exim_release 4.99 OUT-DIR
608 =item B<--[no]cleanup>
610 Do (or do not) cleanup the tmp directory at exit (default: do cleanup)
614 Forces debug mode. (default: no debug info)
616 =item B<--[no]delete>
618 Delete a pre-existing tmp- and package-directory at start. (default: don't delete)
620 =item B<--tmpdir> I<dir>
622 Change the name of the tmp directory (default: temporary directory)
626 Display short help and exit cleanly. (default: don't do that)
630 Control the creation of B<lzip> tarballs. (default: do not use lzip)
632 =item B<--make> I<cmd>
634 Force the use of a specific C<make> command. This may be necessary if C<make> is not
635 C<gmake> (default: C<make>)
639 Display man page and exit cleanly. (default: don't do that)
641 =item B<--tar> I<cmd>
643 Use to override the path to the C<tar> command. Need GNU tar in case
644 I<lzip> is selected. (default: C<gtar>, if not found, use C<tar>)
648 Sign the created archive files (and the sizes.txt). (default: sign)
650 =item B<--key> I<GPG key>
652 Use this GPG key for signing. If nothing is specified the first one of this list
657 =item - git config user.signingkey
659 =item - environment C<EXIM_KEY>
661 =item - default GPG key
667 Control the creation of the website. For creation of the website, the F<../exim-website>
668 (but see the B<website-base> option) directory must exist. (default: create the website)
670 =item B<--website-base> I<dir>
672 Base directory for the web site generation (default: F<../exim-website>)
676 Force verbose mode. (default: no verbosity)
682 Nigel Metheringham <Nigel.Metheringham@dev.intechnology.co.uk>,
683 some changes by Heiko Schlittermann <hs@schlittermann.de>
687 Copyright 2010-2016 Exim Maintainers. All rights reserved.