Release process: fix the --no-web option
[exim.git] / release-process / scripts / mk_exim_release.pl
index e3267fd3e80efb5f5ecf8e68252681a1dbac557e..24c431ea3d84fe06f43193b82b5d38d75e1f1ad0 100755 (executable)
@@ -1,4 +1,5 @@
 #!/usr/bin/env perl
+# Copyright (c) The Exim Maintainers 2016
 
 use strict;
 use warnings;
@@ -22,16 +23,15 @@ sub get_and_check_version {
     my $context = shift;
 
     # make sure this looks like a real release version
-    # which should (currently) be 4.xx or 4.xx_RCx
-    unless ( $release =~ /^(4\.\d\d(?:_RC\d+)?)$/ ) {
+    # which should (currently) be 4.xx[.y] or 4.xx[.y]_RCx
+    unless ( $release =~ /^(?<release>(?<major>4\.\d\d)(?:\.(?<minor>\d+))?(?:_RC\d+)?)$/ ) {
         croak "The given version number does not look right - $release";
     }
-    my $full_release  = $1;              # untainted here...
-    my $trunc_release = $full_release;
-    $trunc_release =~ s/^(4\.\d\d)(?:_RC\d+)?$/$1/;
+    $context->{release}  = $+{release};
+    $context->{major} = $+{major};
+    $context->{minor} = $+{minor};
 
-    $context->{release}  = $full_release;
-    $context->{trelease} = $trunc_release;
+    ($context->{trelease} = $+{release}) =~ s/_RC\d+//;
 }
 
 # ------------------------------------------------------------------
@@ -87,7 +87,6 @@ sub export_git_tree {
     my $archive_file = sprintf( '%s/%s-%s.tar', $context->{tmp}, $context->{pkgname}, $context->{release} );
     $context->{tmp_archive_file} = $archive_file;
     my @cmd = ( 'git', 'archive', '--format=tar', "--output=$archive_file", $context->{tag} );
-
     # run git command
     print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
     system(@cmd) == 0 || croak "Export failed";
@@ -117,20 +116,44 @@ sub make_version_script {
     }
 
     my $srcdir    = File::Spec->catdir( $context->{release_tree}, 'src', 'src' );
-    chdir $srcdir or die "chdir $srcdir: $\n";
+    chdir $srcdir or die "chdir $srcdir: $!\n";
 
     if ( -f "version.sh" ) {
         print( "WARNING: version.sh already exists - leaving it in place\n" );
         return;
     }
 
-    my @cmd = ("../scripts/reversion", "release");
+    # Currently (25. Feb. 2016) the mk_exim_release.pl up to now can't
+    # deal with security releases.!? So we need a current
+    # mk_exim_release.pl. But if we use a current (master), the
+    # reversion script returns wrong version info (it's running inside
+    # the Git tree and uses git --describe, which always returns the
+    # current version of master.) I do not want to change the old
+    # reversion scripts (in 4.86.1, 4.85.1).
+    #
+    # Thus we've to provide the version.sh, based on the info we have
+    # about the release. If reversion finds this, it doesn't try to find
+    # it's own way to get a valid version number from the git.
+    open(my $v, '>', 'version.sh') or die "Can't open '>version.sh' $!\n";
+    print {$v} <<__;
+# initial version automatically generated from $0
+EXIM_RELEASE_VERSION=$context->{major}
+EXIM_VARIANT_VERSION=@{[$context->{minor}?'_'.$context->{minor}:'']}
+EXIM_COMPILE_NUMBER=0
+__
+    close($v);
+    unlink 'version.h';
+    return;
+
+    # Later, if we get the reversion script fixed, we can call it again.
+    # For now (25. Feb. 2016) we'll leave it unused.
+    my @cmd = ("../scripts/reversion", "release", $context->{tag});
     print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
     system(@cmd) == 0 || croak "reversion failed";
 
     unlink "version.h";
 
-    -f "version.sh" or die "failed to create version.h";
+    -f "version.sh" or die "failed to create version.sh";
 }
 
 # ------------------------------------------------------------------
@@ -149,9 +172,9 @@ sub build_html_documentation {
     my @cmd = (
         $genpath,   '--spec',    $spec,                '--filter',
         $filter,    '--latest',  $context->{trelease}, '--tmpl',
-        $templates, '--docroot', $dir,                 '--localstatic',
-        (($verbose||$debug) ? '--verbose' : '')
+        $templates, '--docroot', $dir,                 '--localstatic'
     );
+    push @cmd, '--verbose' if $verbose or $debug;
 
     print "Executing ", join( ' ', @cmd ), "\n";
     system(@cmd);
@@ -193,11 +216,11 @@ sub build_documentation {
 
     my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
     # documentation building gets the truncated release, without RC
-    system("cd '$docdir' && ./OS-Fixups && make EXIM_VER=$context->{trelease} everything") == 0
+    system("cd '$docdir' && ./OS-Fixups && $context->{make_cmd} EXIM_VER=$context->{trelease} everything") == 0
       || croak "Doc build failed";
 
     copy_docbook_files($context);
-    build_html_documentation($context);
+    build_html_documentation($context) if $context->{web};
 }
 
 # ------------------------------------------------------------------
@@ -223,7 +246,11 @@ sub move_text_docs_into_pkg {
         next
           if ( ( $fn eq 'ABOUT' )
             || ( $fn eq 'ChangeLog.0' )
-            || ( $fn eq 'test-harness.txt' ) );
+            || ( $fn eq 'test-harness.txt' )
+            # Debian issue re licensing of RFCs
+            || ( $fn =~ /^draft-ietf-.*/ )
+            || ( $fn =~ /^rfc.*/ )
+             );
         move( $file, File::Spec->catfile( $new_docdir, $fn ) );
     }
 }
@@ -284,7 +311,7 @@ sub build_package_directories {
     my $context = shift;
 
     build_main_package_directory($context);
-    build_pspdfinfo_directory($context);
+    build_pspdfinfo_directory($context) if $context->{build_docs};
 }
 
 # ------------------------------------------------------------------
@@ -293,6 +320,7 @@ sub do_cleanup {
     my $context = shift;
 
     print "Cleaning up\n" if ($verbose);
+    chdir( $context->{directory} ) || die;
     rmtree( $context->{release_tree}, { verbose => $debug } );
     rmtree( $context->{docbook},      { verbose => $debug } );
     rmtree( $context->{pkgdirs},      { verbose => $debug } );
@@ -359,11 +387,14 @@ sub create_tar_files {
         tmp_dir     => File::Temp->newdir(),
         webgen_base => "$FindBin::Bin/../../../exim-website",
         tar_cmd     => 'tar',
+        make_cmd    => 'make',
         compressors => {
                 gzip    => 1,
                 bzip2   => 1,
                 lzip    => 0,
         },
+        build_docs   => 1,
+        web          => 1,
     };
     my $delete;
     my $cleanup = 1;
@@ -373,7 +404,8 @@ sub create_tar_files {
         GetOptions(
             'directory=s'   => \$context->{directory},
             'webgen_base=s' => \$context->{webgen_base},
-            'tar'           => \$context->{tar_cmd},
+            'tar=s'         => \$context->{tar_cmd},
+            'make=s'        => \$context->{make_cmd},
             'lzip!'         => \$context->{compressors}{lzip},
             'verbose!'      => \$verbose,
             'debug!'        => \$debug,
@@ -381,6 +413,8 @@ sub create_tar_files {
             'man!'          => \$man,
             'delete!'       => \$delete,
             'cleanup!'      => \$cleanup,
+            'build-docs!'   => \$context->{build_docs},
+            'web!'          => \$context->{web},
         )
       )
     {
@@ -397,7 +431,7 @@ sub create_tar_files {
     chdir( $context->{directory} ) || die;
     unpack_tree($context);
     make_version_script($context);
-    build_documentation($context);
+    build_documentation($context) if $context->{build_docs};
     build_package_directories($context);
     create_tar_files($context);
     do_cleanup($context) if ($cleanup);
@@ -416,14 +450,16 @@ mk_exim_release.pl - Build an exim release
 mk_exim_release.pl [options] version
 
  Options:
-   --debug             force debug mode (SQL Trace)
+   --debug             force debug mode
    --verbose           force verbose mode
    --help              display this help and exits
    --man               displays man page
    --tar=cmd           command to use for tar
+   --make=cmd          command to use for make
    --directory=dir     dir to package
    --no-lzip           do not create .tar.lz files
    --delete            Delete packaging directory at start
+   --no-web            skip the website generation
 
 =head1 OPTIONS
 
@@ -431,8 +467,7 @@ mk_exim_release.pl [options] version
 
 =item B<--debug>
 
-Forces debug mode cause all SQL statements generated by L<DBIx::Class>
-to be output.
+Forces debug mode.
 
 =item B<--tar>
 
@@ -440,6 +475,11 @@ Use to override the path to the tar command; without this, will search for
 gtar, and if not found use tar.  Need GNU tar for lzip, unless --no-lzip is
 used.
 
+=item B<--make>
+
+Use to override the path/name of the make command.
+Useful sometimes to force gmake.
+
 =item B<--lzip>
 
 Build the lzip tarballs.
@@ -465,7 +505,7 @@ Builds an exim release.
 Starting in a populated git repo that has already been tagged for
 release, build docs, build packages etc.
 
-Parameter is the version number to build as - ie 4.72 4.72RC1 etc
+Parameter is the version number to build as - ie 4.72 4.72RC1, 4.86.1, etc
 
 =head1 AUTHOR