git.sur5r.net Git - i3/i3/blob - release.sh

   1 #!/bin/zsh
   2 # This script is used to prepare a new release of i3.
   3
   4 export RELEASE_VERSION="4.10.2"
   5 export PREVIOUS_VERSION="4.10.1"
   6 export RELEASE_BRANCH="master"
   7
   8 if [ ! -e "../i3.github.io" ]
   9 then
  10         echo "../i3.github.io does not exist."
  11         echo "Use git clone git://github.com/i3/i3.github.io"
  12         exit 1
  13 fi
  14
  15 if [ ! -e "RELEASE-NOTES-${RELEASE_VERSION}" ]
  16 then
  17         echo "RELEASE-NOTES-${RELEASE_VERSION} not found."
  18         exit 1
  19 fi
  20
  21 if git diff-files --quiet --exit-code debian/changelog
  22 then
  23         echo "Expected debian/changelog to be changed (containing the changelog for ${RELEASE_VERSION})."
  24         exit 1
  25 fi
  26
  27 eval $(gpg-agent --daemon)
  28 export GPG_AGENT_INFO
  29
  30 ################################################################################
  31 # Section 1: update git and build the release tarball
  32 ################################################################################
  33
  34 STARTDIR=$PWD
  35
  36 TMPDIR=$(mktemp -d)
  37 cd $TMPDIR
  38 if ! wget http://i3wm.org/downloads/i3-${PREVIOUS_VERSION}.tar.bz2; then
  39         echo "Could not download i3-${PREVIOUS_VERSION}.tar.bz2 (required for comparing files)."
  40         exit 1
  41 fi
  42 git clone --quiet --branch "${RELEASE_BRANCH}" file://${STARTDIR}
  43 cd i3
  44 if [ ! -e "${STARTDIR}/RELEASE-NOTES-${RELEASE_VERSION}" ]; then
  45         echo "Required file RELEASE-NOTES-${RELEASE_VERSION} not found."
  46         exit 1
  47 fi
  48 git checkout -b release-${RELEASE_VERSION}
  49 cp "${STARTDIR}/RELEASE-NOTES-${RELEASE_VERSION}" "RELEASE-NOTES-${RELEASE_VERSION}"
  50 git add RELEASE-NOTES-${RELEASE_VERSION}
  51 git rm RELEASE-NOTES-${PREVIOUS_VERSION}
  52 sed -i "s,<refmiscinfo class=\"version\">[^<]*</refmiscinfo>,<refmiscinfo class=\"version\">${RELEASE_VERSION}</refmiscinfo>,g" man/asciidoc.conf
  53 git commit -a -m "release i3 ${RELEASE_VERSION}"
  54 git tag "${RELEASE_VERSION}" -m "release i3 ${RELEASE_VERSION}" --sign --local-user=0x4AC8EE1D
  55
  56 make dist
  57
  58 echo "Differences in the release tarball file lists:"
  59
  60 diff -u \
  61         <(tar tf ../i3-${PREVIOUS_VERSION}.tar.bz2 | sed "s,i3-${PREVIOUS_VERSION}/,,g" | sort) \
  62         <(tar tf    i3-${RELEASE_VERSION}.tar.bz2  | sed "s,i3-${RELEASE_VERSION}/,,g"  | sort) \
  63         | colordiff
  64
  65 if ! tar xf i3-${RELEASE_VERSION}.tar.bz2 --to-stdout --strip-components=1 i3-${RELEASE_VERSION}/I3_VERSION | grep -q "^${RELEASE_VERSION} "
  66 then
  67         echo "I3_VERSION file does not start with ${RELEASE_VERSION}"
  68         exit 1
  69 fi
  70
  71 gpg --armor -b i3-${RELEASE_VERSION}.tar.bz2
  72
  73 if [ "${RELEASE_BRANCH}" = "master" ]; then
  74         git checkout master
  75         git merge --no-ff release-${RELEASE_VERSION} -m "Merge branch 'release-${RELEASE_VERSION}'"
  76         git checkout next
  77         git merge --no-ff master -m "Merge branch 'master' into next"
  78 else
  79         git checkout next
  80         git merge --no-ff release-${RELEASE_VERSION} -m "Merge branch 'release-${RELEASE_VERSION}'"
  81         git checkout master
  82         git merge --no-ff next -m "Merge branch 'next' into master"
  83 fi
  84
  85 git remote remove origin
  86 git remote add origin git@github.com:i3/i3.git
  87 git config --add remote.origin.push "+refs/tags/*:refs/tags/*"
  88 git config --add remote.origin.push "+refs/heads/next:refs/heads/next"
  89 git config --add remote.origin.push "+refs/heads/master:refs/heads/master"
  90
  91 ################################################################################
  92 # Section 2: Debian packaging
  93 ################################################################################
  94
  95 cd "${TMPDIR}"
  96 mkdir debian
  97
  98 # Copy over the changelog because we expect it to be locally modified in the
  99 # start directory.
 100 cp "${STARTDIR}/debian/changelog" i3/debian/changelog
 101
 102 cat > ${TMPDIR}/Dockerfile <<EOT
 103 FROM debian:sid
 104 RUN sed -i 's,^deb \(.*\),deb \1\ndeb-src \1,g' /etc/apt/sources.list
 105 RUN apt-get update && apt-get install -y dpkg-dev devscripts
 106 COPY i3/i3-${RELEASE_VERSION}.tar.bz2 /usr/src/i3-wm_${RELEASE_VERSION}.orig.tar.bz2
 107 WORKDIR /usr/src/
 108 RUN tar xf i3-wm_${RELEASE_VERSION}.orig.tar.bz2
 109 WORKDIR /usr/src/i3-${RELEASE_VERSION}
 110 COPY i3/debian /usr/src/i3-${RELEASE_VERSION}/debian/
 111 RUN mkdir debian/source
 112 RUN echo '3.0 (quilt)' > debian/source/format
 113 WORKDIR /usr/src
 114 RUN mk-build-deps --install --remove --tool 'apt-get --no-install-recommends -y' i3-${RELEASE_VERSION}/debian/control
 115 WORKDIR /usr/src/i3-${RELEASE_VERSION}
 116 RUN dpkg-buildpackage -sa -j8
 117 EOT
 118
 119 CONTAINER_NAME=$(echo "i3-${TMPDIR}" | sed 's,/,,g')
 120 docker build -t i3 .
 121 for file in $(docker run --name "${CONTAINER_NAME}" i3 /bin/sh -c "ls /usr/src/i3*_${RELEASE_VERSION}*")
 122 do
 123         docker cp "${CONTAINER_NAME}:${file}" ${TMPDIR}/debian/
 124 done
 125
 126 echo "Content of resulting package’s .changes file:"
 127 cat ${TMPDIR}/debian/*.changes
 128
 129 # debsign is in devscripts, which is available in fedora and debian
 130 debsign -k4AC8EE1D ${TMPDIR}/debian/*.changes
 131
 132 # TODO: docker cleanup
 133
 134 ################################################################################
 135 # Section 3: website
 136 ################################################################################
 137
 138 # Ensure we are in the correct branch for copying the docs.
 139 cd ${TMPDIR}/i3
 140 git checkout ${RELEASE_BRANCH}
 141
 142 cd ${TMPDIR}
 143 git clone --quiet ${STARTDIR}/../i3.github.io
 144 cd i3.github.io
 145 cp ${TMPDIR}/i3/i3-${RELEASE_VERSION}.tar.bz2* downloads/
 146 git add downloads/i3-${RELEASE_VERSION}.tar.bz2*
 147 cp ${TMPDIR}/i3/RELEASE-NOTES-${RELEASE_VERSION} downloads/RELEASE-NOTES-${RELEASE_VERSION}.txt
 148 git add downloads/RELEASE-NOTES-${RELEASE_VERSION}.txt
 149 sed -i "s,<h2>Documentation for i3 v[^<]*</h2>,<h2>Documentation for i3 v${RELEASE_VERSION}</h2>,g" docs/index.html
 150 sed -i "s,Verify you are using i3 ≥ .*,Verify you are using i3 ≥ ${RELEASE_VERSION},g" docs/debugging.html
 151 sed -i "s,<span style=\"margin-left: 2em; color: #c0c0c0\">[^<]*</span>,<span style=\"margin-left: 2em; color: #c0c0c0\">${RELEASE_VERSION}</span>,g" index.html
 152 sed -i "s,The current stable version is .*$,The current stable version is ${RELEASE_VERSION}.,g" downloads/index.html
 153 sed -i "s,<tbody>,<tbody>\n  <tr>\n    <td>${RELEASE_VERSION}</td>\n    <td><a href=\"/downloads/i3-${RELEASE_VERSION}.tar.bz2\">i3-${RELEASE_VERSION}.tar.bz2</a></td>\n    <td>$(ls -lh ../i3/i3-${RELEASE_VERSION}.tar.bz2 | awk -F " " {'print $5'} | sed 's/K$/ KiB/g')</td>\n    <td><a href=\"/downloads/i3-${RELEASE_VERSION}.tar.bz2.asc\">signature</a></td>\n    <td>$(date +'%Y-%m-%d')</td>\n    <td><a href=\"/downloads/RELEASE-NOTES-${RELEASE_VERSION}.txt\">release notes</a></td>\n  </tr>\n,g" downloads/index.html
 154
 155 git commit -a -m "add ${RELEASE_VERSION} release"
 156
 157 mkdir docs/${PREVIOUS_VERSION}
 158 tar cf - '--exclude=[0-9]\.[0-9e]*' docs | tar xf - --strip-components=1 -C docs/${PREVIOUS_VERSION}
 159 git add docs/${PREVIOUS_VERSION}
 160 git commit -a -m "save docs for ${PREVIOUS_VERSION}"
 161
 162 for i in $(find _docs -maxdepth 1 -and -type f -and \! -regex ".*\.\(html\|man\)$" -and \! -name "Makefile")
 163 do
 164         base="$(basename $i)"
 165         [ -e "${STARTDIR}/docs/${base}" ] && cp "${STARTDIR}/docs/${base}" "_docs/${base}"
 166 done
 167
 168 (cd _docs && make)
 169
 170 for i in $(find _docs -maxdepth 1 -and -type f -and \! -regex ".*\.\(html\|man\)$" -and \! -name "Makefile")
 171 do
 172         base="$(basename $i)"
 173         [ -e "${STARTDIR}/docs/${base}" ] && cp "_docs/${base}.html" docs/
 174 done
 175
 176 git commit -a -m "update docs for ${RELEASE_VERSION}"
 177
 178 git remote remove origin
 179 git remote add origin git@github.com:i3/i3.github.io.git
 180 git config --add remote.origin.push "+refs/heads/master:refs/heads/master"
 181
 182 ################################################################################
 183 # Section 4: prepare release announcement email
 184 ################################################################################
 185
 186 cd ${TMPDIR}
 187 cat >email.txt <<EOT
 188 From: Michael Stapelberg <michael@i3wm.org>
 189 To: i3-announce@i3.zekjur.net
 190 Subject: i3 v${RELEASE_VERSION} released
 191 Content-Type: text/plain; charset=utf-8
 192 Content-Transfer-Encoding: 8bit
 193
 194 Hi,
 195
 196 I just released i3 v${RELEASE_VERSION}. Release notes follow:
 197 EOT
 198 cat ${TMPDIR}/i3/RELEASE-NOTES-${RELEASE_VERSION} >>email.txt
 199
 200 ################################################################################
 201 # Section 5: final push instructions
 202 ################################################################################
 203
 204 echo "As a final sanity check, install the debian package and see whether i3 works."
 205
 206 echo "When satisfied, run:"
 207 echo "  cd ${TMPDIR}/i3"
 208 echo "  git checkout next"
 209 echo "  vi debian/changelog"
 210 echo "  git commit -a -m \"debian: update changelog\""
 211 echo "  git push"
 212 echo ""
 213 echo "  cd ${TMPDIR}/i3.github.io"
 214 echo "  git push"
 215 echo ""
 216 echo "  cd ${TMPDIR}/debian"
 217 echo "  dput *.changes"
 218 echo ""
 219 echo "  cd ${TMPDIR}"
 220 echo "  sendmail -t < email.txt"
 221 echo ""
 222 echo "Announce on:"
 223 echo "  twitter"
 224 echo "  google+"
 225 echo "  mailing list"
 226 echo "  #i3 topic"