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. "
73 ."Please checkout an older version.\n"
74 if $context->{v
}{major
} < 4
75 or $context->{v
}{major
} == 4 && $context->{v
}{minor
} < 92;
79 # find a valid vcs tag matching the version
80 my $pattern = "$context->{pkgname}-$context->{v}{release}" =~ s/[-_.]/[-_.]/gr;
81 chomp(my @tags = qx{git tag
--list
'$pattern'});
83 croak
"The given version is ambigous, tags: @tags\n" if @tags > 1;
84 croak
"The given version does not exist (no such tag: exim-$version)\n" if @tags == 0;
86 $context->{git_tag
} = $tags[0];
88 # target_release: the release we aim to reach with release candidates
89 # FIXME: re-construct from the parsed version number
90 ($context->{v
}{target_release
} = $context->{v
}{release
}) =~ s/-RC\d+//;
94 # We prefer gtar to tar if gtar exists in $PATH
95 sub override_tar_cmd
{
97 my $tar = $context->{tar_cmd
};
99 return unless $tar eq 'tar';
101 foreach my $d (File
::Spec
->path()) {
102 my $p = catfile
($d, 'gtar');
104 $context->{tar_cmd
} = $p;
105 print "Switched tar command to: $p\n" if $verbose;
111 sub prepare_working_directory
{
113 my $workspace = $context->{workspace
};
115 if (not defined $workspace) {
116 $workspace = $context->{workspace
} = File
::Temp
->newdir(File
::Spec
->tmpdir . '/exim-packaging-XXXX');
119 # ensure the working directory is not in place
121 if ($context->{delete}) {
122 print "Deleting existing $workspace\n" if $verbose;
123 remove_tree
$workspace, { verbose
=> $verbose || $debug };
126 croak
"Working directory $workspace exists" if -e
$workspace;
130 # create base directory
131 make_path
( $context->{directory
}, { verbose
=> $verbose || $debug } );
134 # Set(!) and create subdirectories
135 foreach (qw(vcs_export pkg_tars pkg_trees tmp)) { # {dookbook}
137 $context->{d
}{$_} = catdir
($workspace, $_),
138 { verbose
=> $verbose || $debug });
142 sub export_git_tree
{
146 my $archive_file = $context->{tmp_archive_file
} = sprintf'%s/%s-%s.tar', $context->{d
}{tmp
}, $context->{pkgname
}, $context->{v
}{release
};
148 my @cmd = ( 'git', 'archive', '--format=tar', "--output=$archive_file", $context->{git_tag
} );
151 print "[$cwd] Running: @cmd\n" if $verbose;
152 0 == system @cmd or croak
"Export failed";
156 # TODO: Why can't we combine the export_git_tree with the
157 # unpack_tree function?
161 die "Cannot see archive file\n" unless -f
$context->{tmp_archive_file
};
163 xf
=> $context->{tmp_archive_file
},
164 -C
=> $context->{d
}{vcs_export
} );
167 print "[$cwd] Running: @cmd\n" if $verbose;
168 system @cmd and croak
"Unpack failed\n";
172 sub make_version_script
{
175 #my $variant = substr( $context->{v}{release}, length($context->{v}{target_release}) );
176 #if ( $context->{v}{release} ne $context->{v}{target_release} . $variant ) {
177 # die "Broken version numbering, I'm buggy";
182 if (not my $pid = fork // die "$ME: Cannot fork: $!\n") {
184 my $source_tree = catdir
($context->{d
}{vcs_export
}, 'src', 'src');
187 chdir $source_tree or die "chdir $source_tree: $!\n";
190 croak
"WARNING: version.sh already exists - leaving it in place\n"
193 # Currently (25. Feb. 2016) the mk_exim_release.pl up to now can't
194 # deal with security releases.!? So we need a current
195 # mk_exim_release.pl. But if we use a current (master), the
196 # reversion script returns wrong version info (it's running inside
197 # the Git tree and uses git --describe, which always returns the
198 # current version of master.) I do not want to change the old
199 # reversion scripts (in 4.86.1, 4.85.1).
201 # Thus we've to provide the version.sh, based on the info we have
202 # about the release. If reversion finds this, it doesn't try to find
203 # it's own way to get a valid version number from the git.
205 # 4.89 series: the logic here did not handle _RC<N> thus breaking RC
206 # status in versions. nb: rc in context should be same as $variant
209 #my $stamp = $context->{minor} ? '_'.$context->{minor} : '';
210 #$stamp .= $context->{rc} if $context->{rc};
211 my $variant = $context->{v
}{rc
} // '';
213 print "[$cwd] create version.sh\n" if $verbose;
214 open(my $v, '>', 'version.sh') or die "Can't open version.sh for writing: $!\n";
216 # initial version automatically generated by $0
217 EXIM_RELEASE_VERSION
=$context->{v
}{target_release
}
218 EXIM_VARIANT_VERSION
=$variant
219 EXIM_COMPILE_NUMBER
=0
220 # echo "[[[ \$EXIM_RELEASE_VERSION | \$EXIM_VARIANT_VERSION | \$EXIM_COMPILE_NUMBER ]]]"
222 close $v or die "$0: Can not close $source_tree/version.h: $!\n";
223 unlink 'version.h' or die "$ME: Can not unlink $source_tree/version.h: $!\n"
226 # Later, if we get the reversion script fixed, we can call it again.
227 # For now (25. Feb. 2016) we'll leave it unused.
228 #my @cmd = ('../scripts/reversion', 'release', $context->{git_tag});
230 my @cmd = ('../scripts/reversion', 'release');
231 print "[$cwd] Running: @cmd\n" if $verbose;
232 system(@cmd) and croak
"reversion failed";
234 die "$ME: failed to create version.sh"
235 unless -f
'version.sh';
240 $pid == waitpid($pid, 0) or die "$0: waidpid: $!\n";
245 sub build_documentation
{
247 my $docdir = catdir
$context->{d
}{vcs_export
}, 'doc', 'doc-docbook';
249 # documentation building does a chdir, so we'll do it in a
251 if (not my $pid = fork // die "$ME: Can't fork: $!\n") {
252 chdir $docdir or die "$ME: Can't chdir to $docdir: $!\n";
253 system('./OS-Fixups') == 0 or exit $?
;
254 exec $context->{make_cmd
},
255 "EXIM_VER=$context->{v}{target_release}" .
256 ($context->{v
}{rc
} ?
"-$context->{v}{rc}" : ''),
258 die "$ME: [$cwd] Cannot exec $context->{make_cmd}: $!\n";
265 $context->copy_docbook_files;
266 $context->build_html_documentation if $context->{web
};
269 sub copy_docbook_files
{
272 # where the generated docbook files can be found
273 my $docdir = catdir
$context->{d
}{vcs_export
}, 'doc', 'doc-docbook';
275 foreach ('spec.xml', 'filter.xml') {
276 my $from = catfile
$docdir, $_;
277 my $to = catdir
$context->{d
}{tmp
}; # {dookbook}
278 copy
$from => $to or die $@
;
282 sub build_html_documentation
{
285 # where the website docbook source dir is - push the generated
288 my $webdir = catdir
$context->{website_base
}, 'docbook', $context->{v
}{target_release
};
289 make_path
$webdir, { verbose
=> $verbose + $debug };
290 copy catfile
($context->{d
}{vcs_export
}, 'doc', 'doc-docbook', $_)
292 for 'spec.xml', 'filter.xml';
295 my $gen = catfile
$context->{website_base
}, 'script/gen';
296 my $outdir = catdir
$context->{d
}{pkg_trees
}, "exim-html-$context->{v}{release}";
298 make_path
$outdir, { verbose
=> $verbose || $debug };
302 '--spec' => catfile
($context->{d
}{tmp
}, 'spec.xml'), # {dookbook}
303 '--filter' => catfile
($context->{d
}{tmp
}, 'filter.xml'), # {dookbok}
304 '--latest' => $context->{v
}{target_release
},
305 '--docroot' => $outdir,
307 ($verbose || $debug ?
'--verbose' : ()),
310 print "[$cwd] Executing @cmd\n";
311 0 == system @cmd or exit $?
>> 8;
317 foreach my $tar (glob "$context->{d}{pkg_tars}/*") {
319 '--quiet', '--batch',
320 defined $context->{gpg
}{key
}
321 ?
('--local-user' => $context->{gpg
}{key
})
323 '--detach-sig', '--armor', $tar;
329 make_path
$context->{OUTDIR
}, { verbose
=> $verbose || $debug };
330 move
$_ => $context->{OUTDIR
} or die $@
331 for glob "$context->{d}{pkg_tars}/*";
334 sub build_src_package_directory
{
337 # build the exim package directory path
338 $context->{d
}{src
} = catdir
$context->{d
}{pkg_trees
}, "exim-$context->{v}{release}";
340 # initially we move the exim-src directory to the new directory name
342 catdir
( $context->{d
}{vcs_export
}, 'src')
343 => $context->{d
}{src
}
344 or croak
"Move of src dir failed - $!";
346 # add Local subdirectory
347 make_path
( catdir
( $context->{d
}{src
}, 'Local' ), { verbose
=> $verbose || $debug } );
349 # now add the text docs
350 $context->move_text_docs_into_pkg;
353 sub build_doc_packages_directory
{
356 ##foreach my $format (qw/pdf postscript texinfo info/) {
357 foreach my $format (qw
/pdf postscript/) {
358 my $target = catdir
$context->{d
}{pkg_trees
}, "exim-$format-$context->{v}{release}", 'doc';
359 make_path
( $target, { verbose
=> $verbose || $debug } );
361 # move documents across
365 $context->{d
}{vcs_export
},
369 ( $format eq 'postscript' )
377 move
( $file, catfile
( $target, ( splitpath
($file) )[2] ) );
382 sub move_text_docs_into_pkg
{
385 my $old_docdir = catdir
( $context->{d
}{vcs_export
}, 'doc', 'doc-docbook' );
386 my $old_txtdir = catdir
( $context->{d
}{vcs_export
}, 'doc', 'doc-txt' );
387 my $new_docdir = catdir
( $context->{d
}{src
}, 'doc' );
388 make_path
( $new_docdir, { verbose
=> $verbose || $debug } );
390 # move generated documents from docbook stuff
391 foreach my $file (qw
/exim.8 spec.txt filter.txt/) {
392 die "Empty file \"$file\"\n" if -z catfile
( $old_docdir, $file );
393 move
( catfile
( $old_docdir, $file ), catfile
( $new_docdir, $file ) );
396 # move text documents across
397 foreach my $file ( glob( catfile
( $old_txtdir, '*' ) ) ) {
399 # skip a few we dont want
400 my $fn = ( splitpath
($file) )[2];
402 if ( ( $fn eq 'ABOUT' )
403 || ( $fn eq 'ChangeLog.0' )
404 || ( $fn eq 'test-harness.txt' )
405 # Debian issue re licensing of RFCs
406 || ( $fn =~ /^draft-ietf-.*/ )
407 || ( $fn =~ /^rfc.*/ )
409 move
( $file, catfile
( $new_docdir, $fn ) );
413 sub create_tar_files
{
416 my $pkg_tars = $context->{d
}{pkg_tars
};
417 my $pkg_trees = $context->{d
}{pkg_trees
};
418 my $tar = $context->{tar_cmd
};
420 foreach my $c (keys %{ $context->{compressors
} }) {
421 print "Compression: $c\t$context->{compressors}{$c}\n";
425 # We ideally do not want local system user information in release tarballs;
426 # those are artifacts of use of tar for backups and have no place in
427 # software release packaging; if someone extracts as root, then they should
428 # get sane file ownerships.
430 '--owner' => $context->{tar_perms
}{user
},
431 '--group' => $context->{tar_perms
}{group
},
432 # on this GNU tar, --numeric-owner works during creation too
434 ) if qx/tar --help 2>&1/ =~ /^\s*--owner=/m;
436 # See also environment variables set in main, tuning compression levels
438 gzip
=> { extension
=> 'gz', flags
=> '--gzip' },
439 bzip2
=> { extension
=> 'bz2', flags
=> '--bzip2' },
440 lzip
=> { extension
=> 'lz', flags
=> '--lzip' },
441 xz
=> { extension
=> 'xz', flags
=> '--xz' },
447 foreach my $dir ( glob( catdir
( $pkg_trees, ( 'exim*-' . $context->{v
}{release
} ) ) ) ) {
448 my $dirname = ( splitdir
($dir) )[-1];
449 foreach my $comp (keys %COMPRESSION) {
450 next unless $context->{compressors
}{$comp};
452 my $basename = "$dirname.tar.$COMPRESSION{$comp}{extension}";
453 my $outfile = catfile
$pkg_tars, $basename;
455 print "Creating: $outfile\n" if $verbose || $debug;
458 $COMPRESSION{$comp}{flags
},
459 @ownership, -C
=> $pkg_trees, $dirname)
462 # calculate size and md5sum
463 $size{$basename} = -s
$outfile;
464 $sha256{$basename} = do {
465 my $sha = Digest
::SHA
->new(256);
466 $sha->addfile($outfile);
472 # write the sizes file
473 open my $sizes, '>', $_ = catfile
$pkg_tars, 'sizes.txt'
474 or die "$ME: Can't open `$_': $!\n";
476 print $sizes join "\n",
477 (map { "SIZE($_) = $size{$_}" } sort keys %size),
478 (map { "SHA256($_) = $sha256{$_}" } sort keys %sha256);
480 close($sizes) or die "$ME: Can't close $_: $!\n";
486 print "Cleaning up\n" if $verbose;
487 remove_tree
$context->{d
}{tmp
}, { verbose
=> $debug + $verbose };
494 # some of these settings are useful only if we're in the
495 # exim-projekt-root, but the check, if we're, is deferred
496 my $context = Context
->new(
498 website_base
=> abs_path
('../exim-website'),
521 ##$ENV{'PATH'} = '/opt/local/bin:' . $ENV{'PATH'};
522 # We are creating files for mass distribution, so work harder to make smaller files.
525 # xz documents minimum file sizes for levels higher than -6 to be useful and each
526 # requires more RAM on the decompressing system. Exim tarball currently 24MiB so
528 $ENV{XZ_DEFAULTS
} = -8;
532 qw(workspace|tmp=s outdir=s website_base|webgen_base=s tar_cmd=s make_cmd=s docs|build-docs! web|build-web!
534 'sign!' => \
$context->{gpg
}{sign
},
535 'key=s' => \
$context->{gpg
}{key
},
536 'lzip!' => \
$context->{compressors
}{lzip
},
537 'verbose!' => \
$verbose,
539 'help|?' => sub { pod2usage
(-verbose
=> 1, -exit => 0) },
540 'man!' => sub { pod2usage
(-verbose
=> 2, -exit => 0, -noperldoc
=> system('perldoc -V >/dev/null 2>&1')) },
541 ) and @ARGV == 2 or pod2usage
;
543 -f
'.exim-project-root'
544 or die "$ME: please call this script from the root of the Exim project sources\n";
546 $context->{OUTDIR
} = pop @ARGV;
548 if ($context->{gpg
}{sign
}) {
549 $context->{gpg
}{key
} //= do { chomp($_ = qx/git config user.signingkey/); $_ }
552 warn "$ME: No GPG key, using default\n";
558 warn "$ME: changed umask to 022\n" if umask(022) != 022;
560 $context->check_version(shift);
561 $context->override_tar_cmd;
562 $context->prepare_working_directory;
563 $context->export_git_tree;
564 $context->unpack_tree;
565 $context->make_version_script;
566 $context->build_documentation if $context->{docs
};
568 $context->build_src_package_directory;
569 $context->build_doc_packages_directory if $context->{docs
};
571 $context->create_tar_files;
572 $context->sign if $context->{gpg
}{sign
};
573 $context->move_to_outdir;
574 $context->do_cleanup if $context->{cleanup
};
585 mk_exim_release - Build an exim release
589 mk_exim_release [options] version PKG-DIRECTORY
593 B<mk_exim_release> builds an exim release.
595 Starting in a populated git repo that has already been tagged for
596 release it builds docs, packages etc. Parameter is the version number
597 to build as - ie 4.72 4.72-RC1, 4.86.1, etc, without any prefix.
599 This scripts expects to find a tag "exim-<version>".
601 After creating the release files, they should be signed. There is another
602 helper for creating the signatures:
603 F<release-process/scripts/sign_exim_packages>.
605 Call B<mk_exim_release> about like this:
607 release-process/scripts/mk_exim_release 4.99 OUT-DIR
614 =item B<--[no]cleanup>
616 Do (or do not) cleanup the tmp directory at exit (default: do cleanup)
620 Forces debug mode. (default: no debug info)
622 =item B<--[no]delete>
624 Delete a pre-existing tmp- and package-directory at start. (default: don't delete)
626 =item B<--tmpdir> I<dir>
628 Change the name of the tmp directory (default: temporary directory)
632 Display short help and exit cleanly. (default: don't do that)
636 Control the creation of B<lzip> tarballs. (default: do not use lzip)
638 =item B<--make> I<cmd>
640 Force the use of a specific C<make> command. This may be necessary if C<make> is not
641 C<gmake> (default: C<make>)
645 Display man page and exit cleanly. (default: don't do that)
647 =item B<--tar> I<cmd>
649 Use to override the path to the C<tar> command. Need GNU tar in case
650 I<lzip> is selected. (default: C<gtar>, if not found, use C<tar>)
654 Sign the created archive files (and the sizes.txt). (default: sign)
656 =item B<--key> I<GPG key>
658 Use this GPG key for signing. If nothing is specified the first one of this list
663 =item - git config user.signingkey
665 =item - environment C<EXIM_KEY>
667 =item - default GPG key
673 Control the creation of the website. For creation of the website, the F<../exim-website>
674 (but see the B<website-base> option) directory must exist. (default: create the website)
676 =item B<--website-base> I<dir>
678 Base directory for the web site generation (default: F<../exim-website>)
682 Force verbose mode. (default: no verbosity)
688 Nigel Metheringham <Nigel.Metheringham@dev.intechnology.co.uk>,
689 some changes by Heiko Schlittermann <hs@schlittermann.de>
693 Copyright 2010-2016 Exim Maintainers. All rights reserved.