18 # ------------------------------------------------------------------
20 sub get_and_check_version
{
24 # make sure this looks like a real release version
25 # which should (currently) be 4.xx or 4.xx_RCx
26 unless ( $release =~ /^(4\.\d\d(?:_RC\d+)?)$/ ) {
27 croak
"The given version number does not look right - $release";
29 my $full_release = $1; # untainted here...
30 my $trunc_release = $full_release;
31 $trunc_release =~ s/^(4\.\d\d)(?:_RC\d+)?$/$1/;
33 $context->{release
} = $full_release;
34 $context->{trelease
} = $trunc_release;
37 # ------------------------------------------------------------------
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;
47 return sprintf( 'exim-%s', $modversion );
50 # ------------------------------------------------------------------
52 sub deal_with_working_directory
{
56 # Set default directory
57 $context->{directory
} ||= File
::Spec
->rel2abs( sprintf( 'exim-packaging-%s', $context->{release
} ) );
58 my $directory = $context->{directory
};
60 # ensure the working directory is not in place
61 if ( -d
$directory ) {
63 print "Deleting existing $directory\n" if ($verbose);
64 rmtree
( $directory, { verbose
=> $debug } );
66 if ( -d
$directory ) {
67 croak
"Working directory $directory exists";
71 # create base directory
72 mkpath
( $context->{directory
}, { verbose
=> ( $verbose || $debug ) } );
74 # set and create subdirectories
75 foreach (qw(release_tree pkgs pkgdirs docbook tmp)) {
76 $context->{$_} = File
::Spec
->catdir( $context->{directory
}, $_ );
77 mkpath
( $context->{$_}, { verbose
=> ( $verbose || $debug ) } );
81 # ------------------------------------------------------------------
87 my $archive_file = sprintf( '%s/%s-%s.tar', $context->{tmp
}, $context->{pkgname
}, $context->{release
} );
88 $context->{tmp_archive_file
} = $archive_file;
89 my @cmd = ( 'git', 'archive', '--format=tar', "--output=$archive_file", $context->{tag
} );
92 print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
93 system(@cmd) == 0 || croak
"Export failed";
96 # ------------------------------------------------------------------
101 die "Cannot see archive file\n" unless ( -f
$context->{tmp_archive_file
} );
102 my @cmd = ( 'tar', 'xf', $context->{tmp_archive_file
}, '-C', $context->{release_tree
} );
105 print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
106 system(@cmd) == 0 || croak
"Unpack failed";
109 # ------------------------------------------------------------------
111 sub make_version_script
{
114 return if ($context->{release
} eq $context->{trelease
});
116 my $variant = substr( $context->{release
}, length($context->{trelease
}) );
117 if ( $context->{release
} ne $context->{trelease
} . $variant ) {
118 die "Broken version numbering, I'm buggy";
121 my $srcdir = File
::Spec
->catdir( $context->{release_tree
}, 'src', 'src' );
122 chdir $srcdir or die "chdir $srcdir: $\n";
124 if ( -f
"version.sh" ) {
125 print( "WARNING: version.sh already exists - leaving it in place\n" );
129 my @cmd = ("../scripts/reversion", "release");
130 print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
131 system(@cmd) == 0 || croak
"reversion failed";
135 -f
"version.sh" or die "failed to create version.h";
138 # ------------------------------------------------------------------
140 sub build_html_documentation
{
143 my $genpath = $context->{webgen_base
} . '/script/gen.pl';
144 my $templates = $context->{webgen_base
} . '/templates';
145 my $dir = File
::Spec
->catdir( $context->{release_tree
}, 'html' );
146 my $spec = File
::Spec
->catfile( $context->{docbook
}, 'spec.xml' );
147 my $filter = File
::Spec
->catfile( $context->{docbook
}, 'filter.xml' );
152 ( $genpath, '--spec', $spec, '--filter', $filter, '--latest', $context->{trelease
}, '--tmpl', $templates, '--docroot', $dir );
154 print "Executing ", join( ' ', @cmd ), "\n";
157 # move directory into right place
158 my $sourcedir = File
::Spec
->catdir( $context->{docbook
}, 'filter.xml' );
161 File
::Spec
->catdir( $dir, sprintf( 'exim-html-%s', $context->{trelease
} ) ),
162 File
::Spec
->catdir( $context->{pkgdirs
}, sprintf( 'exim-html-%s', $context->{release
} ) )
166 # ------------------------------------------------------------------
168 sub copy_docbook_files
{
171 # where the generated docbook files can be found
172 my $docdir = File
::Spec
->catdir( $context->{release_tree
}, 'doc', 'doc-docbook' );
174 # where the website docbook source dir is - push files to here
175 my $webdir = File
::Spec
->catdir( $context->{webgen_base
}, 'docbook', $context->{trelease
} );
176 mkpath
( $webdir, { verbose
=> ( $verbose || $debug ) } );
178 foreach my $file ( 'spec.xml', 'filter.xml' ) {
179 my $from = File
::Spec
->catfile( $docdir, $file );
180 my $to = File
::Spec
->catfile( $context->{docbook
}, $file );
181 my $webto = File
::Spec
->catfile( $webdir, $file );
183 copy
( $from, $webto );
187 # ------------------------------------------------------------------
189 sub build_documentation
{
192 my $docdir = File
::Spec
->catdir( $context->{release_tree
}, 'doc', 'doc-docbook' );
193 system("cd '$docdir' && ./OS-Fixups && make everything") == 0
194 || croak
"Doc build failed";
196 copy_docbook_files
($context);
197 build_html_documentation
($context);
200 # ------------------------------------------------------------------
202 sub move_text_docs_into_pkg
{
205 my $old_docdir = File
::Spec
->catdir( $context->{release_tree
}, 'doc', 'doc-docbook' );
206 my $old_txtdir = File
::Spec
->catdir( $context->{release_tree
}, 'doc', 'doc-txt' );
207 my $new_docdir = File
::Spec
->catdir( $context->{eximpkgdir
}, 'doc' );
208 mkpath
( $new_docdir, { verbose
=> ( $verbose || $debug ) } );
210 # move generated documents from docbook stuff
211 foreach my $file (qw
/exim.8 spec.txt filter.txt/) {
212 move
( File
::Spec
->catfile( $old_docdir, $file ), File
::Spec
->catfile( $new_docdir, $file ) );
215 # move text documents across
216 foreach my $file ( glob( File
::Spec
->catfile( $old_txtdir, '*' ) ) ) {
218 # skip a few we dont want
219 my $fn = ( File
::Spec
->splitpath($file) )[2];
221 if ( ( $fn eq 'ABOUT' )
222 || ( $fn eq 'ChangeLog.0' )
223 || ( $fn eq 'test-harness.txt' ) );
224 move
( $file, File
::Spec
->catfile( $new_docdir, $fn ) );
228 # ------------------------------------------------------------------
230 sub build_pspdfinfo_directory
{
233 ##foreach my $format (qw/pdf postscript texinfo info/) {
234 foreach my $format (qw
/pdf postscript/) {
235 my $target = File
::Spec
->catdir( $context->{pkgdirs
}, sprintf( 'exim-%s-%s', $format, $context->{release
} ), 'doc' );
236 mkpath
( $target, { verbose
=> ( $verbose || $debug ) } );
238 # move documents across
242 $context->{release_tree
},
246 ( $format eq 'postscript' )
254 move
( $file, File
::Spec
->catfile( $target, ( File
::Spec
->splitpath($file) )[2] ) );
259 # ------------------------------------------------------------------
261 sub build_main_package_directory
{
264 # build the exim package directory path
265 $context->{eximpkgdir
} = File
::Spec
->catdir( $context->{pkgdirs
}, sprintf( 'exim-%s', $context->{release
} ) );
267 # initially we move the exim-src directory to the new directory name
268 rename( File
::Spec
->catdir( $context->{release_tree
}, 'src' ), $context->{eximpkgdir
} )
269 || croak
"Rename of src dir failed - $!";
271 # add Local subdirectory
272 mkpath
( File
::Spec
->catdir( $context->{eximpkgdir
}, 'Local' ), { verbose
=> ( $verbose || $debug ) } );
274 # now add the text docs
275 move_text_docs_into_pkg
($context);
278 # ------------------------------------------------------------------
280 sub build_package_directories
{
283 build_main_package_directory
($context);
284 build_pspdfinfo_directory
($context);
287 # ------------------------------------------------------------------
292 print "Cleaning up\n" if ($verbose);
293 rmtree
( $context->{release_tree
}, { verbose
=> $debug } );
294 rmtree
( $context->{docbook
}, { verbose
=> $debug } );
295 rmtree
( $context->{pkgdirs
}, { verbose
=> $debug } );
298 # ------------------------------------------------------------------
300 sub create_tar_files
{
303 my $pkgs = $context->{pkgs
};
304 my $pkgdirs = $context->{pkgdirs
};
305 foreach my $dir ( glob( File
::Spec
->catdir( $pkgdirs, ( 'exim*-' . $context->{release
} ) ) ) ) {
306 my $dirname = ( File
::Spec
->splitdir($dir) )[-1];
307 system("tar cfz ${pkgs}/${dirname}.tar.gz -C ${pkgdirs} ${dirname}");
308 system("tar cfj ${pkgs}/${dirname}.tar.bz2 -C ${pkgdirs} ${dirname}");
312 # ------------------------------------------------------------------
318 orig_dir
=> File
::Spec
->curdir(),
319 tmp_dir
=> File
::Temp
->newdir(),
320 webgen_base
=> "$FindBin::Bin/../../../exim-website",
324 ##$ENV{'PATH'} = '/opt/local/bin:' . $ENV{'PATH'};
328 'directory=s' => \
$context->{directory
},
329 'webgen_base=s' => \
$context->{webgen_base
},
330 'verbose!' => \
$verbose,
334 'delete!' => \
$delete,
335 'cleanup!' => \
$cleanup,
339 pod2usage
( -exitval
=> 1, -verbose
=> 0 );
341 pod2usage
(0) if $help;
342 pod2usage
( -verbose
=> 2 ) if $man;
344 get_and_check_version
( shift, $context );
345 $context->{tag
} = build_tag
($context);
346 deal_with_working_directory
( $context, $delete );
347 export_git_tree
($context);
348 chdir( $context->{directory
} ) || die;
349 unpack_tree
($context);
350 make_version_script
($context);
351 build_documentation
($context);
352 build_package_directories
($context);
353 create_tar_files
($context);
354 do_cleanup
($context) if ($cleanup);
363 mk_exim_release.pl - Build an exim release
367 mk_exim_release.pl [options] version
370 --debug force debug mode (SQL Trace)
371 --verbose force verbose mode
372 --help display this help and exits
373 --man displays man page
374 --directory=dir dir to package
375 --delete Delete packaging directory at start
383 Forces debug mode cause all SQL statements generated by L<DBIx::Class>
388 Force verbose mode - currently this has no effect
392 Display help and exits
402 Builds an exim release.
404 Starting in a populated git repo that has already been tagged for
405 release, build docs, build packages etc.
407 Parameter is the version number to build as - ie 4.72 4.72RC1 etc
411 Nigel Metheringham <Nigel.Metheringham@dev.intechnology.co.uk>
415 Copyright 2010 Exim Maintainers. All rights reserved.