Change naming of local patch-related branches and unify
[rsync/rsync.git] / packaging / release-rsync
index b939470..939e5b9 100755 (executable)
@@ -1,22 +1,40 @@
 #!/usr/bin/perl
-use strict;
-
 # This script expects the directory ~/samba-rsync-ftp to exist and to be a
 # copy of the /home/ftp/pub/rsync dir on samba.org.  When the script is done,
 # the git repository in the current directory will be updated, and the local
 # ~/samba-rsync-ftp dir will be ready to be rsynced to samba.org.
 
+use strict;
+use warnings;
 use Cwd;
+use Getopt::Long;
+use Term::ReadKey;
 use Date::Format;
 
 my $dest = $ENV{HOME} . '/samba-rsync-ftp';
-
-my $cl_today = time2str('* %a %b %d %Y', time);
-my $ztoday = time2str('%d %b %Y', time);
+my $passfile = $ENV{HOME} . '/.rsyncpass';
+my $path = $ENV{PATH};
+my $make_gen_cmd = 'make -f prepare-source.mak conf && ./config.status && make gen';
+
+&Getopt::Long::Configure('bundling');
+&usage if !&GetOptions(
+    'branch|b=s' => \( my $master_branch = 'master' ),
+    'help|h' => \( my $help_opt ),
+);
+&usage if $help_opt;
+
+my $now = time;
+my $cl_today = time2str('* %a %b %d %Y', $now);
+my $year = time2str('%Y', $now);
+my $ztoday = time2str('%d %b %Y', $now);
 (my $today = $ztoday) =~ s/^0//;
 
 my $curdir = Cwd::cwd;
 
+END {
+    unlink($passfile);
+}
+
 my @extra_files;
 open(IN, '<', 'Makefile.in') or die "Couldn't open Makefile.in: $!\n";
 while (<IN>) {
@@ -43,29 +61,45 @@ die "There is no .git dir in the current directory.\n" unless -d '.git';
 die "'a' must not exist in the current directory.\n" if -e 'a';
 die "'b' must not exist in the current directory.\n" if -e 'b';
 
-open(IN, '-|', 'git status') or die $!;
-my $status = join('', <IN>);
-close IN;
-die "The checkout is not clean:\n", $status unless $status =~ /\nnothing to commit \(working directory clean\)/;
-die "The checkout is not on the master branch.\n" unless $status =~ /^# On branch master\n/;
+require 'packaging/git-status.pl';
+check_git_state($master_branch, 1, 1);
 
-my $lastversion;
+my $confversion;
 open(IN, '<', 'configure.in') or die $!;
 while (<IN>) {
     if (/^RSYNC_VERSION=(.*)/) {
-       $lastversion = $1;
+       $confversion = $1;
        last;
     }
 }
 close IN;
-if ($lastversion =~ /dev$/) {
-    open(IN, '<', 'OLDNEWS') or die $!;
-    $_ = <IN>;
-    close IN;
-    ($lastversion) = /(\d+\.\d+\.\d+)/;
+die "Unable to find RSYNC_VERSION in configure.in\n" unless defined $confversion;
+
+open(IN, '<', 'OLDNEWS') or die $!;
+$_ = <IN>;
+my($lastversion) = /(\d+\.\d+\.\d+)/;
+my($last_protocol_version, %pdate);
+while (<IN>) {
+    if (my($ver,$pdate,$pver) = /^\s+\S\S\s\S\S\S\s\d\d\d\d\s+(\d+\.\d+\.\d+)\s+(\d\d \w\w\w \d\d\d\d\s+)?(\d+)$/) {
+       $pdate{$ver} = $pdate if defined $pdate;
+       $last_protocol_version = $pver if $ver eq $lastversion;
+    }
 }
+close IN;
+die "Unable to determine protocol_version for $lastversion.\n" unless defined $last_protocol_version;
+
+my $protocol_version;
+open(IN, '<', 'rsync.h') or die $!;
+while (<IN>) {
+    if (/^#define\s+PROTOCOL_VERSION\s+(\d+)/) {
+       $protocol_version = $1;
+       last;
+    }
+}
+close IN;
+die "Unable to determine the current PROTOCOL_VERSION.\n" unless defined $protocol_version;
 
-my $version = $lastversion;
+my $version = $confversion;
 $version =~ s/dev/pre1/ || $version =~ s/pre(\d+)/ 'pre' . ($1 + 1) /e;
 
 print "Please enter the version number of this release: [$version] ";
@@ -75,31 +109,63 @@ if ($_ eq '.') {
 } elsif ($_ ne '') {
     $version = $_;
 }
-$version =~ s/[-.]*pre[-.]*/pre/;
+die "Invalid version: `$version'\n" unless $version =~ /^[\d.]+(pre\d+)?$/;
+
+if (`git tag -l v$version` ne '') {
+    print "Tag v$version already exists.\n\nDelete tag or quit? [q/del] ";
+    $_ = <STDIN>;
+    exit 1 unless /^del/i;
+    system "git tag -d v$version";
+}
+
+if ($version =~ s/[-.]*pre[-.]*/pre/ && $confversion !~ /dev$/) {
+    $lastversion = $confversion;
+}
 
 print "Enter the previous version to produce a patch against: [$lastversion] ";
 chomp($_ = <STDIN>);
 $lastversion = $_ if $_ ne '';
 $lastversion =~ s/[-.]*pre[-.]*/pre/;
 
-my $release = 1;
+my $pre = $version =~ /(pre\d+)/ ? $1 : '';
+
+my $release = $pre ? '0.1' : '1';
 print "Please enter the RPM release number of this release: [$release] ";
 chomp($_ = <STDIN>);
 $release = $_ if $_ ne '';
+$release .= ".$pre" if $pre;
 
-my $diffdir;
-my $skipping;
+(my $finalversion = $version) =~ s/pre\d+//;
+my($proto_changed,$proto_change_date);
+if ($protocol_version eq $last_protocol_version) {
+    $proto_changed = 'unchanged';
+    $proto_change_date = "\t\t";
+} else {
+    $proto_changed = 'changed';
+    if (!defined($proto_change_date = $pdate{$finalversion})) {
+       while (1) {
+           print "On what date did the protocol change to $protocol_version get checked in? (dd Mmm yyyy) ";
+           chomp($_ = <STDIN>);
+           last if /^\d\d \w\w\w \d\d\d\d$/;
+       }
+       $proto_change_date = "$_\t";
+    }
+}
+
+my($srcdir,$srcdiffdir,$lastsrcdir,$skipping);
 if ($lastversion =~ /pre/) {
-    if ($version !~ /pre/) {
+    if (!$pre) {
        die "You should not diff a release version against a pre-release version.\n";
     }
-    $diffdir = "$dest/old-previews";
+    $srcdir = $srcdiffdir = $lastsrcdir = 'src-previews';
     $skipping = ' ** SKIPPING **';
-} elsif ($version =~ /pre/) {
-    $diffdir = $dest;
+} elsif ($pre) {
+    $srcdir = $srcdiffdir = 'src-previews';
+    $lastsrcdir = 'src';
     $skipping = ' ** SKIPPING **';
 } else {
-    $diffdir = "$dest/old-versions";
+    $srcdir = $lastsrcdir = 'src';
+    $srcdiffdir = 'src-diffs';
     $skipping = '';
 }
 
@@ -108,14 +174,16 @@ print "\n", $break, <<EOT;
 \$lastversion is "$lastversion"
 \$dest is "$dest"
 \$curdir is "$curdir"
-\$diffdir is "$diffdir"
+\$srcdir is "$srcdir"
+\$srcdiffdir is "$srcdiffdir"
+\$lastsrcdir is "$lastsrcdir"
 \$release is "$release"
 
 About to:
-    - make sure that SUBPROTOCOL_VERSION is 0$skipping
+    - tweak SUBPROTOCOL_VERSION in rsync.h, if needed
     - tweak the version in configure.in and the spec files
-    - tweak NEWS and OLDNEWS to update the release date$skipping
-    - tweak the date in the *.yo files and generate the man pages
+    - tweak NEWS and OLDNEWS to ensure header values are correct
+    - tweak the date in the *.yo files and generate the manpages
     - generate configure.sh, config.h.in, and proto.h
     - page through the differences
 
@@ -123,34 +191,54 @@ EOT
 print "<Press Enter to continue> ";
 $_ = <STDIN>;
 
-my @tweak_files = ( glob('packaging/*.spec'), glob('packaging/*/*.spec'),
-                   glob('*.yo'), qw( configure.in ) );
+my %specvars = ( 'Version:' => $finalversion, 'Release:' => $release,
+                '%define fullversion' => "\%{version}$pre", 'Released' => "$version.",
+                '%define srcdir' => $srcdir );
+my @tweak_files = ( glob('packaging/*.spec'), glob('packaging/*/*.spec'), glob('*.yo'),
+                   qw( configure.in rsync.h NEWS OLDNEWS options.c ) );
 
-if ($version !~ /pre/) {
-    push(@tweak_files, qw( rsync.h NEWS OLDNEWS ));
-}
 foreach my $fn (@tweak_files) {
     open(IN, '<', $fn) or die $!;
     undef $/; $_ = <IN>; $/ = "\n";
     close IN;
     if ($fn =~ /configure/) {
-       s/^RSYNC_VERSION=.*/RSYNC_VERSION=$version/m;
+       s/^RSYNC_VERSION=.*/RSYNC_VERSION=$version/m
+           or die "Unable to update RSYNC_VERSION in $fn\n";
     } elsif ($fn =~ /\.spec/) {
-       s/^(Version:) .*/$1 $version/m;
-       s/^(Release:) .*/$1 $release/m;
-       s/^(Released) .*/$1 $version./m;
-       s/^\* \w\w\w \w\w\w \d\d \d\d\d\d (.*)/$cl_today $1/m;
+       while (my($str, $val) = each %specvars) {
+           s/^\Q$str\E .*/$str $val/m
+               or die "Unable to update $str in $fn\n";
+       }
+       s/^\* \w\w\w \w\w\w \d\d \d\d\d\d (.*)/$cl_today $1/m
+           or die "Unable to update ChangeLog header in $fn\n";
     } elsif ($fn =~ /\.yo/) {
-       s/^(manpage\([^)]+\)\(\d+\)\()[^)]+(\).*)/$1$today$2/m;
-       s/^(This man ?page is current for version) \S+ (of rsync)/$1 $version $2/m;
-    } elsif ($fn eq 'NEWS') {
-       s/^(NEWS for rsync \Q$version\E) \(UNRELEASED\)\s*\n/$1 ($today)\n/mi
-           or die "Couldn't update NEWS file with release date!\n";
+       s/^(manpage\([^)]+\)\(\d+\)\()[^)]+(\).*)/$1$today$2/m
+           or die "Unable to update date in manpage() header in $fn\n";
+       s/^(This man ?page is current for version) \S+ (of rsync)/$1 $version $2/m
+           or die "Unable to update current version info in $fn\n";
     } elsif ($fn eq 'rsync.h') {
-       s/(#define\s+SUBPROTOCOL_VERSION)\s+\d+/$1 0/;
+       s{(#define\s+SUBPROTOCOL_VERSION)\s+(\d+)}
+        { $1 . ' ' . get_subprotocol_version($2) }e
+           or die "Unable to find SUBPROTOCOL_VERSION define in $fn\n";
+    } elsif ($fn eq 'NEWS') {
+       s{^(NEWS for rsync \Q$finalversion\E )(\(UNRELEASED\))\s*(\nProtocol: )(\d+) (\([^)]+\))\n}
+        { $1 . ($pre ? $2 : "($today)") . "$3$protocol_version ($proto_changed)\n" }ei
+           or die "The first 2 lines of $fn are not in the right format.  They must be:\n"
+                . "NEWS for rsync $finalversion (UNRELEASED)\n"
+                . "Protocol: $protocol_version ($proto_changed)\n";
     } elsif ($fn eq 'OLDNEWS') {
-       s/^\t\S\S\s\S\S\S\s\d\d\d\d(\t\Q$version\E)/\t$ztoday$1/m
-           or die "Couldn't update OLDNEWS file with release date!\n";
+       s{^(\t\S\S\s\S\S\S\s\d\d\d\d)(\t\Q$finalversion\E\t).*}
+        { ($pre ? $1 : "\t$ztoday") . $2 . $proto_change_date . $protocol_version }em
+           or die "Unable to find \"?? ??? $year\t$finalversion\" line in $fn\n";
+    } elsif ($fn eq 'options.c') {
+       if (s/(Copyright \(C\) 2002-)(\d+)( Wayne Davison)/$1$year$3/
+        && $2 ne $year) {
+           die "Copyright comments need to be updated to $year in all files!\n";
+       }
+       # Adjust the year in the --version output.
+       s/(rprintf\(f, "Copyright \(C\) 1996-)(\d+)/$1$year/
+           or die "Unable to find Copyright string in --version output of $fn\n";
+       next if $2 eq $year;
     } else {
        die "Unrecognized file in \@tweak_files: $fn\n";
     }
@@ -165,83 +253,102 @@ system "git diff --color | less -p '^diff .*'";
 my $srctar_name = "rsync-$version.tar.gz";
 my $pattar_name = "rsync-patches-$version.tar.gz";
 my $diff_name = "rsync-$lastversion-$version.diffs.gz";
-my $srctar_file = "$dest/$srctar_name";
-my $pattar_file = "$dest/$pattar_name";
-my $diff_file = "$dest/$diff_name";
-my $lasttar_file = "$dest/rsync-$lastversion.tar.gz";
+my $srctar_file = "$dest/$srcdir/$srctar_name";
+my $pattar_file = "$dest/$srcdir/$pattar_name";
+my $diff_file = "$dest/$srcdiffdir/$diff_name";
+my $news_file = "$dest/$srcdir/rsync-$version-NEWS";
+my $lasttar_file = "$dest/$lastsrcdir/rsync-$lastversion.tar.gz";
 
 print $break, <<EOT;
 
 About to:
-    - commit all changes
-    - tag this release as v$version
-    - move the old tar/diff files into the appropriate old-* dirs
-    - hard-link the moved tar/diff files on samba.org
-    - create release tar, "$srctar_name"
-    - create patches tar, "$pattar_name"
-    - create release diffs, "$diff_name"
-    - update patch branches and generate patch/* files
-    - update README, *NEWS, TODO, and changelog
-    - update rsync*.html man pages
-    - gpg-sign the release files
+    - commit all version changes
+    - merge the $master_branch branch into the patch/$master_branch/* branches
+    - update the files in the "patches" dir and OPTIONALLY
+      (if you type 'y') to launch a shell for each patch
 
 EOT
-print "<Press Enter to continue> ";
-$_ = <STDIN>;
+print "<Press Enter OR 'y' to continue> ";
+my $ans = <STDIN>;
 
 system "git commit -a -m 'Preparing for release of $version'" and exit 1;
-system "git tag -s -m 'Version $version.' v$version" and exit 1;
 
-# Extract some files from the old tar before we do the shuffle.
-@_ = @extra_files;
-map { s#^#rsync-$lastversion/# } @_;
-system "tar xzf $lasttar_file @_";
-rename("rsync-$lastversion", 'a');
-
-# When creating a pre-release after a normal release, there's nothing to move.
-if ($diffdir ne $dest) {
-    chdir($dest) or die $!;
+print "Updating files in \"patches\" dir ...\n";
+system "packaging/patch-update --branch=$master_branch";
 
-    print "Shuffling old files ...\n";
+if ($ans =~ /^y/i) {
+    print "\nVisiting all \"patch/$master_branch/*\" branches ...\n";
+    system "packaging/patch-update --branch=$master_branch --shell";
+}
 
-    # We need to run this regardless of $lastversion's "pre"ness.
-    my @moved_files;
-    foreach my $fn (glob('rsync*pre*.tar.gz*'), glob('rsync*pre*-NEWS')) {
-       link($fn, "old-previews/$fn") or die $!;
-       push(@moved_files, $fn);
-    }
+if (-d 'patches/.git') {
+    system "cd patches && git commit -a -m 'The patches for $version.'" and exit 1;
+}
 
-    if ($version !~ /pre/) {
-       foreach my $fn (glob('rsync*.tar.gz*'), glob('rsync*-NEWS')) {
-           next if $fn =~ /^rsync.*pre/;
-           link($fn, "old-versions/$fn") or die $!;
-           push(@moved_files, $fn);
-       }
+print $break, <<EOT;
 
-       foreach my $fn (glob('rsync*pre*.diffs.gz*')) {
-           unlink($fn);
-       }
+About to:
+    - create signed tag for this release: v$version
+    - create release diffs, "$diff_name"
+    - create release tar, "$srctar_name"
+    - generate rsync-$version/patches/* files
+    - create patches tar, "$pattar_name"
+    - update top-level README, *NEWS, TODO, and ChangeLog
+    - update top-level rsync*.html manpages
+    - gpg-sign the release files
+    - update hard-linked top-level release files$skipping
 
-       foreach my $fn (glob('rsync*.diffs.gz*')) {
-           link($fn, "old-patches/$fn") or die $!;
-           push(@moved_files, $fn);
-       }
-    }
+EOT
+print "<Press Enter to continue> ";
+$_ = <STDIN>;
 
-    # Optimize our future upload (in the absence of --detect-renamed) by
-    # using rsync to hard-link the above files on samba.org.
-    system "rsync -avHOC --include='rsync*.gz*' --include='old-*/' --exclude='*' . samba.org:/home/ftp/pub/rsync";
-    foreach (@moved_files) {
-       unlink($_);
+# We want to use our passphrase-providing "gpg" script, so modify the PATH.
+$ENV{PATH} = "$curdir/packaging/bin:$path";
+
+my $passphrase;
+while (1) {
+    ReadMode('noecho');
+    print "\nEnter your GPG pass-phrase: ";
+    chomp($passphrase = <STDIN>);
+    ReadMode(0);
+    print "\n";
+
+    # Briefly create a temp file with the passphrase for git's tagging use.
+    my $oldmask = umask 077;
+    unlink($passfile);
+    open(OUT, '>', $passfile) or die $!;
+    print OUT $passphrase, "\n";
+    close OUT;
+    umask $oldmask;
+    $ENV{'GPG_PASSFILE'} = $passfile;
+
+    $_ = `git tag -s -m 'Version $version.' v$version 2>&1`;
+    print $_;
+    next if /bad passphrase/;
+    exit 1 if /failed/;
+
+    if (-d 'patches/.git') {
+       $_ = `cd patches && git tag -s -m 'Version $version.' v$version 2>&1`;
+       print $_;
+       exit 1 if /bad passphrase|failed/;
     }
 
-    chdir($curdir) or die $!;
+    unlink($passfile);
+    last;
 }
 
+$ENV{PATH} = $path;
+
+# Extract the generated files from the old tar.
+@_ = @extra_files;
+map { s#^#rsync-$lastversion/# } @_;
+system "tar xzf $lasttar_file @_";
+rename("rsync-$lastversion", 'a');
+
 print "Creating $diff_file ...\n";
-system "./config.status Makefile; make gen; rsync -a @extra_files b/";
+system "$make_gen_cmd && rsync -a @extra_files b/" and exit 1;
 my $sed_script = 's:^((---|\+\+\+) [ab]/[^\t]+)\t.*:\1:';
-system "(git diff v$lastversion v$version; diff -up a b | sed -r '$sed_script') | gzip -9 >$diff_file";
+system "(git diff v$lastversion v$version; diff -upN a b | sed -r '$sed_script') | gzip -9 >$diff_file";
 system "rm -rf a";
 rename('b', "rsync-$version");
 
@@ -250,24 +357,65 @@ system "git archive --format=tar --prefix=rsync-$version/ v$version | tar xf -";
 system "support/git-set-file-times --prefix=rsync-$version/";
 system "fakeroot tar czf $srctar_file rsync-$version; rm -rf rsync-$version";
 
+print "Updating files in \"rsync-$version/patches\" dir ...\n";
 mkdir("rsync-$version", 0755);
 mkdir("rsync-$version/patches", 0755);
-system "support/patch-update --skip-check --gen=rsync-$version/patches";
+system "packaging/patch-update --skip-check --branch=$master_branch --gen=rsync-$version/patches";
+
+print "Creating $pattar_file ...\n";
 system "fakeroot tar chzf $pattar_file rsync-$version/patches; rm -rf rsync-$version";
 
 print "Updating the other files in $dest ...\n";
 system "rsync -a README NEWS OLDNEWS TODO $dest";
-unlink("$dest/rsync-$version-NEWS");
-link("$dest/NEWS", "$dest/rsync-$version-NEWS");
-system "git log --name-status | gzip -9 >$dest/changelog.gz";
+unlink($news_file);
+link("$dest/NEWS", $news_file);
+system "git log --name-status | gzip -9 >$dest/ChangeLog.gz";
 
 system "yodl2html -o $dest/rsync.html rsync.yo";
 system "yodl2html -o $dest/rsyncd.conf.html rsyncd.conf.yo";
 
-chdir($dest) or die $!;
-system "gpg -ba $srctar_name; gpg -ba $pattar_name; gpg -ba $diff_name";
-print $break, <<EOT;
+foreach my $fn ($srctar_file, $pattar_file, $diff_file) {
+    unlink("$fn.asc");
+    open(GPG, '|-', "gpg --batch --passphrase-fd=0 -ba $fn") or die $!;
+    print GPG $passphrase, "\n";
+    close GPG;
+}
+
+if (!$pre) {
+    system "rm $dest/rsync-*.gz $dest/rsync-*.asc $dest/rsync-*-NEWS $dest/src-previews/rsync-*diffs.gz*";
+
+    foreach my $fn ($srctar_file, "$srctar_file.asc",
+                   $pattar_file, "$pattar_file.asc",
+                   $diff_file, "$diff_file.asc", $news_file) {
+       (my $top_fn = $fn) =~ s#/src(-\w+)?/#/#;
+       link($fn, $top_fn);
+    }
+}
+
+print $break, <<'EOT';
+
+Local changes are done.  When you're satisfied, push the git repository
+and rsync the release files.  Remember to announce the release on *BOTH*
+rsync-announce@lists.samba.org and rsync@lists.samba.org (and the web)!
+EOT
+
+exit;
 
-All done.  Remember to announce the release on *BOTH*
-rsync-announce\@lists.samba.org and rsync\@lists.samba.org!
+sub get_subprotocol_version
+{
+    my($subver) = @_;
+    if ($pre && $proto_changed eq 'changed') {
+       return $subver == 0 ? 1 : $subver;
+    }
+    0;
+}
+
+sub usage
+{
+    die <<EOT;
+Usage: release-rsync [OPTIONS]
+
+-b, --branch=BRANCH   The branch to release (default: master)
+-h, --help            Display this help message
 EOT
+}