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