mk-release.inc

   1 #@ Include file for the mk-release.sh generic release builder.
   2 #@ It also needs two hooks: update_stable_hook(), update_release_hook(),
   3 #@ which need to "git add" what they have modified.
   4
   5 : ${PROGRAM:?"Need \$PROGRAM"}
   6 : ${UPROGRAM:?"Need \$UPROGRAM"}
   7 : ${MANUAL:?"May need \$MANUAL for announcement references"}
   8
   9 : ${UPLOAD:?"Need \$UPLOAD URL for scp(1)"}
  10
  11 : ${MAILX:=mailx}
  12 : ${ACCOUNT:?"May need mailx(1) -A \$ACCOUNT"}
  13 : ${MAILTO:?"May need \$MAILTO for announcement"}
  14 : ${MAILBCC:?"May need \$MAILBCC for announcement"}
  15
  16 ##  --  >8  --  8<  --  ##
  17
  18 ORIG_LC_ALL=${LC_ALL} LC_ALL=C
  19 export LC_ALL
  20
  21 DATE_MAN=`date -u +'%b %d, %Y'`
  22 DATE_ISO=`date -u +%Y-%m-%d`
  23
  24 yesno() {
  25    while [ 1 ]; do
  26       [ ${#} -gt 0 ] && printf '%s ' "${@}"
  27       printf '[y/n] '
  28       read i
  29       case ${i} in
  30       [Yy]*) return 0;;
  31       [Nn]*) return 1;;
  32       *) ;;
  33       esac
  34    done
  35 }
  36
  37 headref="`git rev-parse --verify HEAD`"
  38 brref=
  39 for i in `git rev-parse --branches=stable master^{commit}`; do
  40    if [ ${headref} = ${i} ]; then
  41       brref=${headref}
  42       break
  43    fi
  44 done
  45 if [ -z "${brref}" ]; then
  46    echo >&2 'Not on the [master] or a [stable/*] branch'
  47    exit 1
  48 fi
  49 if [ "`git status --porcelain --ignored |
  50       awk 'BEGIN{no=0}{++no}END{print no}'`" -ne 0 ]; then
  51    echo >&2 'Directory not clean, see git status --ignored'
  52    exit 2
  53 fi
  54
  55 echo 'Preparing a release on commit '"${headref}"
  56 #brname="`git branch | sed -e '/^* /b X' -e d -e :X -e 's/^* //'`"
  57 brname=`git symbolic-ref --short HEAD`
  58 echo '  That is '"${brname}"
  59 printf '  Name of release tag: '
  60 read REL
  61 VERSION=${REL}
  62 vmaj=`{ echo ${VERSION}; } | sed -e 's/^\([^.]\{1,\}\).*/\1/'`
  63 vmin=`{ echo ${VERSION}; } | sed -e 's/^[^.]\{1,\}\.\([^.]\{1,\}\).*/\1/'`
  64 [ ${vmin} = ${VERSION} ] && VERSION=${VERSION}.0 vmin=0
  65 vupd=`{ echo ${VERSION}; } |
  66       sed -e 's/^[^.]\{1,\}\.[^.]\{1,\}\.\([^.-]\{1,\}\).*/\1/'`
  67 [ ${vupd} = ${VERSION} ] && VERSION=${VERSION}.0 vupd=0
  68 REL=${VERSION}
  69 export VERSION
  70 if yesno 'Is '${PROGRAM}' <v'${REL}'> correct?'; then :; else
  71    echo >&2 'Bailing out'
  72    exit 3
  73 fi
  74
  75 stblbrname=stable/v${vmaj}.${vmin}
  76 brref=`git rev-parse --verify ${stblbrname} 2>/dev/null`
  77 if [ -z "${brref}" ]; then
  78    if yesno 'Create and switch to new branch '"${stblbrname}"; then
  79       git checkout -b ${stblbrname}
  80    fi
  81 elif [ ${brref} != ${headref} ] || [ ${brname} != ${stblbrname} ]; then
  82    echo >&2 "For ${REL} we should be on ${stblbrname}, not ${brname}"
  83    echo >&2 'Bailing out'
  84    exit 4
  85 fi
  86
  87 relbrname=release/v${VERSION}
  88 brref=`git rev-parse --verify ${relbrname} 2>/dev/null`
  89 if [ -z "${brref}" ]; then :; else
  90    echo >&2 "The ${relbrname} already exists"
  91    echo >&2 'Bailing out'
  92    exit 5
  93 fi
  94
  95 ##
  96 echo 'Updating stable/ files to match the release'
  97
  98 if [ -f version.h ] && [ -f mk-mk.in ]; then
  99    grep=grep sed=sed cmp=cmp mv=mv make -f mk-mk.in _update-version
 100    git add version.h
 101 fi
 102 update_stable_hook
 103
 104 LC_ALL=${ORIG_LC_ALL} git commit -S -m "Bump ${UPROGRAM} v${REL}, ${DATE_ISO}"
 105 LC_ALL=${ORIG_LC_ALL} git tag -s -f \
 106    -m "Bump ${UPROGRAM} v${REL}, ${DATE_ISO}" "v${REL}"
 107
 108 ##
 109
 110 if yesno 'Create release/ branch?'; then
 111    git checkout -b ${relbrname}
 112
 113    git rm -f .gitignore .mailmap TODO
 114    update_release_hook
 115
 116    LC_ALL=${ORIG_LC_ALL} git commit -S \
 117       -m "Bump ${UPROGRAM} v${REL}.ar, ${DATE_ISO}"
 118    LC_ALL=${ORIG_LC_ALL} git tag -s -f \
 119       -m "Bump ${UPROGRAM} v${REL}.ar, ${DATE_ISO}" "v${REL}.ar"
 120
 121    if yesno 'Shall i update release/latest "symlink"?'; then
 122       git update-ref refs/heads/release/latest ${relbrname}
 123    fi
 124    if yesno 'Shall i update release/stable "symlink"?'; then
 125       git update-ref refs/heads/release/stable ${relbrname}
 126    fi
 127 else
 128    relbrname=${stblbrname}
 129 fi
 130
 131 ##
 132 # [timeline]
 133
 134 if [ ${relbrname} != ${stblbrname} ] &&
 135       `git rev-parse --verify timeline^{commit} >/dev/null 2>&1` &&
 136       yesno 'Shall i update [timeline]?'; then
 137    git checkout timeline
 138    git rm -rf '*'
 139    git archive --format=tar "v${REL}.ar" | tar -x -f -
 140    git add .
 141    LC_ALL=${ORIG_LC_ALL} git commit -S -m "${UPROGRAM} v${REL}.ar, ${DATE_ISO}"
 142 fi
 143
 144 ##
 145 # repo push
 146
 147 [ ${relbrname} != ${stblbrname} ] && git checkout ${stblbrname}
 148 git log --no-walk --decorate --oneline --branches --remotes
 149 yesno 'Push git(1) repo?' && git push
 150
 151 ##
 152 # Big balls
 153
 154 if [ ${relbrname} != ${stblbrname} ] && yesno 'Create tarballs?'; then
 155    bigballs=y
 156    (
 157    # Repack with standard tar(1) to avoid new-style headers
 158    git archive --format=tar --prefix="${PROGRAM}-${REL}/" "v${REL}.ar" |
 159       ( cd "${TMPDIR}" && tar -x -f - )
 160    cd "${TMPDIR}"
 161    tar -c -f "${PROGRAM}-${REL}.tar" "${PROGRAM}-${REL}"
 162
 163    openssl md5 "${PROGRAM}-${REL}.tar" > "${PROGRAM}-${REL}.cksum"
 164    openssl sha1 "${PROGRAM}-${REL}.tar" >> "${PROGRAM}-${REL}.cksum"
 165    openssl sha256 "${PROGRAM}-${REL}.tar" >> "${PROGRAM}-${REL}.cksum"
 166    openssl sha512 "${PROGRAM}-${REL}.tar" >> "${PROGRAM}-${REL}.cksum"
 167    gpg --detach-sign --armor "${PROGRAM}-${REL}.tar"
 168    cat "${PROGRAM}-${REL}.tar.asc" >> "${PROGRAM}-${REL}.cksum"
 169
 170    < "${PROGRAM}-${REL}.tar" gzip > "${PROGRAM}-${REL}.tar.gz"
 171    < "${PROGRAM}-${REL}.tar" xz -e -C sha256 > "${PROGRAM}-${REL}.tar.xz"
 172    )
 173 else
 174    bigballs=
 175 fi
 176
 177 ##
 178 # Announcement .txt and .html
 179
 180 if yesno 'Prepare announcement?'; then
 181    anntxt=y
 182    if `git rev-parse --verify announce^{blob} >/dev/null 2>&1`; then
 183       git show announce > "${TMPDIR}/${PROGRAM}-${REL}.txt"
 184    else
 185       : > "${TMPDIR}/${PROGRAM}-${REL}.txt"
 186    fi
 187    if [ -n "${bigballs}" ] && [ -f "${TMPDIR}/${PROGRAM}-${REL}.cksum" ]; then
 188       echo >> "${TMPDIR}/${PROGRAM}-${REL}.txt"
 189       cat "${TMPDIR}/${PROGRAM}-${REL}.cksum" >>\
 190          "${TMPDIR}/${PROGRAM}-${REL}.txt"
 191    fi
 192    if `git cat-file -e ${relbr}:NEWS 2>/dev/null`; then
 193       echo >> "${TMPDIR}/${PROGRAM}-${REL}.txt"
 194       git show ${relbr}:NEWS >> "${TMPDIR}/${PROGRAM}-${REL}.txt"
 195    fi
 196
 197    ${EDITOR} "${TMPDIR}/${PROGRAM}-${REL}.txt"
 198
 199    # HTML convert ready for S-Web42
 200    APO=\'
 201    < "${TMPDIR}/${PROGRAM}-${REL}.txt" awk -v manual="${MANUAL}" '
 202    BEGIN{
 203       header = 1
 204       hot = 0
 205       print "<?begin?><?mode icewatsm?><pre>"
 206    }
 207    function strips(){
 208       gsub("&", "\\&amp;")
 209       gsub("<", "\\&lt;")
 210       gsub(">", "\\&gt;")
 211    }
 212    /^[[:space:]]*s-.*-mode[[:space:]]*$/{
 213       header = 1
 214       next
 215    }
 216    /ChangeLog|shortlog/{
 217       if(header)
 218          next
 219       if(hot == 0)
 220          hot = 1
 221       strips()
 222    }
 223    /Appendix/{
 224       if(header)
 225          next
 226       hot = -1
 227       strips()
 228    }
 229    {
 230       if(header){
 231          if(length == 0)
 232             header = 0
 233          next
 234       }
 235       strips()
 236       if(hot <= 0){
 237          print
 238          next
 239       }
 240       any = 0
 241       res = ""
 242       s = $0
 243       while(match(s,
 244             /(`|\*)[-/_[:alnum:]]+('${APO}'|\*)#[0-9]+(\|#_?[0-9]+)?/)){
 245          pre = substr(s, 1, RSTART - 1)
 246          mat = substr(s, RSTART, RLENGTH)
 247          s = substr(s, RSTART + RLENGTH)
 248
 249          if(match(mat, /\|#_?[0-9]+/)){
 250             targ = substr(mat, RSTART + 2)
 251             mat = substr(mat, 1, RSTART - 1)
 252          }else{
 253             match(mat, /#[0-9]+/)
 254             targ = substr(mat, RSTART + 1, RLENGTH)
 255          }
 256          res = res pre "<?lreft " manual "#" targ "<>" mat "?>"
 257          any = 1
 258       }
 259       if(any && length(s))
 260          res = res s
 261       print any ? res : s
 262    }
 263    END{
 264       print "</pre><?end?>"
 265    }
 266    ' > "${TMPDIR}/.${PROGRAM}-ann.html"
 267 else
 268    anntxt=
 269 fi
 270
 271 ##
 272 # Upload
 273
 274 if [ -n "${bigballs}" ] && yesno 'Upload archives'; then
 275    (
 276    cd "${TMPDIR}"
 277
 278    cat <<-_EOT
 279                 -put ${PROGRAM}-${REL}.tar
 280                 -rm ${PROGRAM}-latest.tar
 281                 -ln ${PROGRAM}-${REL}.tar ${PROGRAM}-latest.tar
 282
 283                 -put ${PROGRAM}-${REL}.tar.gz
 284                 -rm ${PROGRAM}-latest.tar.gz
 285                 -ln ${PROGRAM}-${REL}.tar.gz ${PROGRAM}-latest.tar.gz
 286
 287                 -put ${PROGRAM}-${REL}.tar.xz
 288                 -rm ${PROGRAM}-latest.tar.xz
 289                 -ln ${PROGRAM}-${REL}.tar.xz ${PROGRAM}-latest.tar.xz
 290
 291                 -put ${PROGRAM}-${REL}.tar.asc
 292                 -rm ${PROGRAM}-latest.tar.asc
 293                 -ln ${PROGRAM}-${REL}.tar.asc ${PROGRAM}-latest.tar.asc
 294
 295                 -chmod 0644 ${PROGRAM}-${REL}.tar*
 296         _EOT
 297
 298    if [ -n "${anntxt}" ]; then
 299       cat <<-_EOT
 300                         echo "-put ${PROGRAM}-${REL}.txt"
 301                         echo "-rm ${PROGRAM}-latest.txt"
 302                         echo "-ln ${PROGRAM}-${REL}.txt ${PROGRAM}-latest.txt"
 303                         echo "-chmod 0644 ${PROGRAM}-${REL}.txt"
 304                 _EOT
 305    fi
 306    ) |
 307    sftp -b - ${UPLOAD}
 308 fi
 309
 310 ##
 311 # Announcement mail
 312
 313 if [ -n "${anntxt}" ] && yesno 'Send announcement mail?'; then
 314    LC_ALL=${ORIG_LC_ALL} ${MAILX} -A ${ACCOUNT} \
 315       -s "[ANN]ounce of ${UPROGRAM} v${REL}" \
 316       -q "${TMPDIR}/${PROGRAM}-${REL}.txt" \
 317       -b ${MAILBCC} ${MAILTO}
 318 fi
 319
 320 # Finally remove the temporary instances than ran this
 321 rm -f .git/mk-release.sh .git/mk-release.inc
 322 echo 'Done'
 323 exit
 324 # s-sh-mode