admin/automerge

   1 #!/bin/bash
   2 ### automerge - automatically merge the Emacs release branch to master
   3
   4 ## Copyright (C) 2018-2024 Free Software Foundation, Inc.
   5
   6 ## Author: Glenn Morris <rgm@gnu.org>
   7 ## Maintainer: Stefan Kangas <stefankangas@gmail.com>
   8
   9 ## This file is part of GNU Emacs.
  10
  11 ## GNU Emacs is free software: you can redistribute it and/or modify
  12 ## it under the terms of the GNU General Public License as published by
  13 ## the Free Software Foundation, either version 3 of the License, or
  14 ## (at your option) any later version.
  15
  16 ## GNU Emacs is distributed in the hope that it will be useful,
  17 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ## GNU General Public License for more details.
  20
  21 ## You should have received a copy of the GNU General Public License
  22 ## along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
  23
  24 ### Commentary:
  25
  26 ## Automatically merge the Emacs release branch to master.
  27 ## If the merge succeeds, optionally build and test the results,
  28 ## and then push it.
  29 ## Intended usage:
  30 ## Have a dedicated git directory just for this.
  31 ## Have a cron job that calls this script with -r -p.
  32 ##
  33 ## Modifying a running shell script can have unpredictable results,
  34 ## so the paranoid will first make a copy of this script, and then run
  35 ## it with the -d option in the repository directory, in case a pull
  36 ## updates this script while it is working.
  37
  38 source "${0%/*}/emacs-shell-lib"
  39
  40 usage ()
  41 {
  42     cat 1>&2 <<EOF
  43 Usage: ${PN} [-b] [-d] [-e emacs] [-n nmin] [-p] [-r] [-t] [-- mflags]
  44 Merge the Emacs release branch to master.
  45 Passes any non-option args to make (eg -- -j2).
  46 Options:
  47 -d: no initial cd to parent of script directory
  48 -e: Emacs executable to use for the initial merge (default $emacs)
  49 -n: minimum number of commits to try merging (default $nmin)
  50 -b: try to build after merging
  51 -t: try to check after building
  52 -p: if merge, build, check all succeed, push when finished (caution!)
  53 -r: start by doing a hard reset (caution!) and pull
  54 EOF
  55     exit 1
  56 }
  57
  58
  59 ## Defaults.
  60
  61 emacs=emacs
  62 nmin=10
  63 build=
  64 test=
  65 push=
  66 quiet=
  67 reset=
  68 nocd=
  69
  70 while getopts ":hbde:n:pqrt" option ; do
  71     case $option in
  72         (h) usage ;;
  73
  74         (b) build=1 ;;
  75
  76         (d) nocd=1 ;;
  77
  78         (e) emacs=$OPTARG ;;
  79
  80         (n) nmin=$OPTARG ;;
  81
  82         (p) push=1 ;;
  83
  84         (q) quiet=1 ;;
  85
  86         (r) reset=1 ;;
  87
  88         (t) test=1 ;;
  89
  90         (\?) die "Bad option -$OPTARG" ;;
  91
  92         (:) die "Option -$OPTARG requires an argument" ;;
  93
  94         (*) die "getopts error" ;;
  95     esac
  96 done
  97 shift $(( --OPTIND ))
  98 OPTIND=1
  99
 100
 101 [ "$nocd" ] || {
 102     # $PD should be the admin directory
 103     cd $PD || die "Could not change directory to $PD"
 104     cd ../
 105 }
 106
 107 [ -d admin ] || die "Could not locate admin directory"
 108
 109 [ -e .git ] || die "No .git"
 110
 111
 112 ## Does not work 100% because a lot of Emacs batch output comes on
 113 ## stderr (?).
 114 [ "$quiet" ] && exec 1> /dev/null
 115
 116
 117 [ "$push" ] && test=1
 118 [ "$test" ] && build=1
 119
 120
 121 tempfile="$(emacs_mktemp)"
 122
 123
 124 [ -e Makefile ] && [ "$build" ] && {
 125     echo "Cleaning..."
 126     make maintainer-clean >& /dev/null
 127 }
 128
 129
 130 [ "$reset" ] && {
 131     echo "Resetting..."
 132     git reset -q --hard origin/master || die "reset error"
 133
 134     echo "Pulling..."
 135     git pull -q --ff-only || die "pull error"
 136 }
 137
 138
 139 rev=$(git rev-parse HEAD)
 140
 141 [ "$(git rev-parse @{u})" = "$rev" ] || die "Local state does not match origin"
 142
 143
 144 merge ()
 145 {
 146     echo "Merging..."
 147
 148     if $emacs --batch -Q -l ./admin/gitmerge.el \
 149               --eval "(setq gitmerge-minimum-missing $nmin)" -f gitmerge \
 150               >| "$tempfile" 2>&1; then
 151         echo "merged ok"
 152         return 0
 153
 154     else
 155         grep -E "Nothing to merge|Number of missing commits" "$tempfile" && \
 156             exit 0
 157
 158         cat "$tempfile" 1>&2
 159
 160         die "merge error"
 161     fi
 162 }
 163
 164
 165 merge
 166
 167
 168 ## FIXME it would be better to trap this in gitmerge.
 169 ## NEWS should never be modified, only eg NEWS.26.
 170 git diff --stat --cached origin/master | grep -q "etc/NEWS " && \
 171     die "etc/NEWS has been modified"
 172
 173
 174 [ "$build" ] || exit 0
 175
 176
 177 echo "Running autoreconf..."
 178
 179 autoreconf -i -I m4 2>| "$tempfile"
 180
 181 retval=$?
 182
 183 ## Annoyingly, autoreconf puts the "installing `./foo' messages on stderr.
 184 if [ "$quiet" ]; then
 185     grep -v 'installing `\.' "$tempfile" 1>&2
 186 else
 187     cat "$tempfile" 1>&2
 188 fi
 189
 190 [ $retval -ne 0 ] && die "autoreconf error"
 191
 192
 193 echo "Running ./configure..."
 194
 195 ## Minimize required packages.
 196 ./configure --without-x || die "configure error"
 197
 198
 199 echo "Building..."
 200
 201 make "$@" || die "make error"
 202
 203 echo "Build finished ok"
 204
 205
 206 [ "$test" ] || exit 0
 207
 208
 209 echo "Testing..."
 210
 211 ## We just want a fast pass/fail, we don't want to debug.
 212 make "$@" check TEST_LOAD_EL=no || die "check error"
 213
 214 echo "Tests finished ok"
 215
 216
 217 [ "$push" ] || exit 0
 218
 219
 220 ## In case someone else pushed while we were working.
 221 echo "Checking for remote changes..."
 222 git fetch || die "fetch error"
 223
 224 [ "$(git rev-parse @{u})" = "$rev" ] || {
 225
 226     echo "Upstream has changed"
 227
 228     ## Rebasing would be incorrect, since it would rewrite the
 229     ## (already published) release branch commits.
 230     ## Ref eg https://lists.gnu.org/r/emacs-devel/2014-12/msg01435.html
 231     ## Instead, we throw away what we just did, and do the merge again.
 232     echo "Resetting..."
 233     git reset --hard "$rev"
 234
 235     echo "Pulling..."
 236     git pull --ff-only || die "pull error"
 237
 238     merge
 239
 240     ## If the merge finished ok again, we don't bother doing a second
 241     ## build and test.
 242 }
 243
 244 echo "Pushing..."
 245 git push || die "push error"
 246
 247
 248 exit 0