]>
Commit | Line | Data |
---|---|---|
ea4bf6cd | 1 | #!/bin/bash |
5e18ef4f XL |
2 | # Release a packaged crate to Debian. |
3 | # | |
4 | # Usage: [REALVER=<EXACTVER>] ./release.sh <CRATE> [<SEMVER>] | |
5 | # | |
6 | # Envvars: | |
7 | # See also ./vars.sh.frag for its envvars, which we pass through. | |
8 | # See also ./build.sh for its envvars, which we pass through. | |
9 | # RERELEASE=1 | |
10 | # Bump the changelog for a source-only reupload, required for migration to | |
11 | # Debian Testing, and automatically dput the tarball. You need this after a | |
12 | # NEW upload. This is a dumb consequence of two independently-thought-out | |
13 | # policies but nobody on either team has expressed interest in fixing it, | |
14 | # claiming "not my department". | |
15 | # NOUPDATE=1 | |
16 | # Tell debcargo not to attempt to update to the latest version, i.e. | |
17 | # autodetect REALVER. Set this if you get unexpected diffs when releasing. | |
18 | # We probably want to switch this on by default, please complain in our IRC | |
19 | # channel if you agree. | |
20 | # REUSE_EXISTING_ORIG_TARBALL=1 | |
21 | # Re-use the existing .orig tarball. This is needed if it was previously | |
22 | # generated with an old version of debcargo, otherwise you'll get | |
23 | # auto-REJECT from Debian FTP. TODO: we probably want to set this | |
24 | # automatically on if the Debian version ends with -2 or above. | |
931eabc0 XL |
25 | |
26 | . ./vars.sh.frag | |
27 | ||
2c47a4e5 SL |
28 | RED=`echo -e "\033[1;31m"` |
29 | NC=`echo -e "\033[0m"` | |
30 | ||
e19e9e08 SL |
31 | if test ! -d $PKGDIR_REL; then |
32 | abort 1 "Cannot find $PKGDIR_REL. Did you run ./new-package.sh before?" | |
33 | fi | |
34 | ||
c1621660 XL |
35 | if test ! -f "$PKGDIR_REL/debian/changelog"; then |
36 | abort 1 "Cannot find $PKGDIR_REL/debian/changelog. Did you run ./new-package.sh before?" | |
37 | fi | |
38 | ||
e3cf5e2c | 39 | if git grep --quiet FIXME -- "$PKGDIR_REL" :^"$PKGDIR_REL/debian/*.debcargo.hint" :^"$PKGDIR_REL/debian/changelog"; then |
89c70e95 XL |
40 | abort 1 "FIXMEs remain in $PKGDIR_REL, fix and commit those first." |
41 | fi | |
42 | ||
1230b71f XL |
43 | git diff --quiet --cached || \ |
44 | abort 1 "You have other pending changes to git, please complete it or stash it away and re-run this script." | |
45 | ||
46 | git diff --quiet -- "$PKGDIR_REL" || \ | |
931eabc0 XL |
47 | abort 1 "Please git-add your changes to $PKGDIR_REL before running" |
48 | ||
1057693c XL |
49 | type dch >/dev/null || \ |
50 | abort 1 "Install devscripts, we need to run dch." | |
51 | ||
b6a1d240 XL |
52 | RELBRANCH="pending-$PKGNAME" |
53 | git fetch origin --prune | |
2de6944f | 54 | |
c75ca09f | 55 | git merge-base --is-ancestor origin/master HEAD || \ |
90f3bab9 | 56 | abort 1 "You are not synced with origin/master, please do so before running this script." |
1c8790a3 | 57 | |
baae6f7c XL |
58 | if [ "$RERELEASE" = 1 -o "$NOUPDATE" = 1 ]; then |
59 | REALVER="$(get_existing_version "$PKGDIR")" | |
60 | fi | |
61 | ||
2de6944f | 62 | if head -n1 "$PKGDIR/debian/changelog" | grep -qv UNRELEASED-FIXME-AUTOGENERATED-DEBCARGO; then |
baae6f7c XL |
63 | if [ "$RERELEASE" = 1 ]; then |
64 | run_debcargo | |
65 | ( cd "$PKGDIR" && dch -a "No-op source-only re-upload for Debian Testing Migration." ) | |
30bf7f25 | 66 | export REUSE_EXISTING_ORIG_TARBALL=1 |
baae6f7c XL |
67 | else |
68 | abort 0 \ | |
69 | "Package already released. If you want to do a source-only re-upload e.g. to" \ | |
70 | "hoop-jump through the Debian Testing migration requirements, set RERELEASE=1." | |
71 | fi | |
2de6944f XL |
72 | fi |
73 | ||
e1a9d897 XL |
74 | if [ -e "$PKGDIR/debian/BLOCK" ]; then |
75 | abort 1 "TODO items remain in $PKGDIR/debian/BLOCK, please deal with those" | |
76 | fi | |
77 | ||
32c1fb5b XL |
78 | PREVBRANCH="$(git rev-parse --abbrev-ref HEAD)" |
79 | case "$PREVBRANCH" in | |
b6a1d240 XL |
80 | pending-$PKGNAME) true;; |
81 | pending-*) abort 1 "You are on a pending-release branch for a package other than $PKGNAME, $0 can only be run on another branch, like master";; | |
82 | *) if git rev-parse -q --verify "refs/heads/$RELBRANCH" >/dev/null || \ | |
83 | git rev-parse -q --verify "refs/remotes/origin/$RELBRANCH" >/dev/null; then | |
84 | git checkout "$RELBRANCH" | |
85 | else | |
86 | git checkout -b "$RELBRANCH" | |
87 | fi;; | |
88 | esac | |
89 | ||
90 | if head -n1 "$PKGDIR/debian/changelog" | grep -qv UNRELEASED-FIXME-AUTOGENERATED-DEBCARGO; then | |
32c1fb5b | 91 | git checkout "$PREVBRANCH" |
c6709bfe XL |
92 | abort 0 "Package already released on branch $RELBRANCH. If that was a mistake then run:" \ |
93 | " git branch -D $RELBRANCH" \ | |
94 | "And re-run this script ($0 $*). You might have to delete the remote branch too:" \ | |
95 | " git push --delete origin $RELBRANCH" | |
b6a1d240 | 96 | fi |
1230b71f | 97 | |
931eabc0 XL |
98 | ( cd "$PKGDIR" |
99 | sed -i -e s/UNRELEASED-FIXME-AUTOGENERATED-DEBCARGO/UNRELEASED/ debian/changelog | |
699de4ac SL |
100 | if test -z "$DISTRO"; then |
101 | # To upload to other distro like experimental | |
102 | DISTRO=unstable | |
103 | fi | |
104 | dch -m -r -D $DISTRO "" | |
931eabc0 | 105 | git add debian/changelog |
d30bb8e0 | 106 | git rm --ignore-unmatch debian/RFS |
931eabc0 XL |
107 | ) |
108 | ||
cc003c95 | 109 | revert_git_changes() { |
8c0b9df4 | 110 | git reset --merge |
d30bb8e0 AS |
111 | git checkout -- "$PKGDIR/debian/changelog" |
112 | git checkout -q -- "$PKGDIR/debian/RFS" || true | |
e185876a XL |
113 | git checkout "$PREVBRANCH" |
114 | git branch -d "$RELBRANCH" | |
cc003c95 XL |
115 | } |
116 | ||
117 | if ! run_debcargo --changelog-ready; then | |
118 | revert_git_changes | |
119 | abort 1 "Release attempt failed to run debcargo, probably the package needs updating (./update.sh $*)" | |
120 | fi | |
121 | ||
30bf7f25 XL |
122 | # sometimes the copyright years need to be updated, try to do this automatically |
123 | if git diff -- "$PKGDIR_REL/debian/copyright.debcargo.hint" | patch -r - --no-backup-if-mismatch "$PKGDIR_REL/debian/copyright"; then | |
124 | git add "$PKGDIR_REL/debian/copyright.debcargo.hint" "$PKGDIR_REL/debian/copyright" | |
125 | else | |
126 | git diff -- "$PKGDIR_REL/debian/copyright.debcargo.hint" | |
127 | revert_git_changes | |
128 | abort 1 \ | |
129 | "copyright file needs updating; apply the above diff to $PKGDIR_REL/debian/copyright" \ | |
130 | "then commit your changes, and run me again." | |
131 | fi | |
132 | ||
cc003c95 XL |
133 | if ! git diff --exit-code -- "$PKGDIR_REL"; then |
134 | revert_git_changes | |
baae6f7c XL |
135 | abort 1 \ |
136 | "Release attempt resulted in git diffs to $PKGDIR_REL, probably you need to update the package (./update.sh $*)." \ | |
137 | "Alternatively, set NOUPDATE=1 to override this requirement, but please have a good reason." | |
e185876a | 138 | fi |
931eabc0 | 139 | |
1057693c | 140 | if ! ( cd build && SOURCEONLY=1 ./build.sh "$CRATE" $VER ); then |
cc003c95 | 141 | revert_git_changes |
98cad301 XL |
142 | abort 1 "Release attempt failed (see messages above), possible reasons are: " \ |
143 | "- build-dependencies not in Debian => release those first." \ | |
144 | "- packaged version is out-of-date => run \`./update.sh $*\`" | |
cc003c95 XL |
145 | fi |
146 | ||
999f9269 | 147 | git commit -m "Release package $PKGNAME" |
931eabc0 | 148 | |
1057693c XL |
149 | DEBVER=$(dpkg-parsechangelog -l $BUILDDIR/debian/changelog -SVersion) |
150 | DEBSRC=$(dpkg-parsechangelog -l $BUILDDIR/debian/changelog -SSource) | |
550dd343 | 151 | DEB_HOST_ARCH=$(dpkg-architecture -q DEB_HOST_ARCH) |
b6a1d240 | 152 | |
baae6f7c | 153 | if [ "$RERELEASE" = 1 ]; then |
baae6f7c | 154 | |
508cd1b3 XL |
155 | ( cd build && dput "${DEBSRC}_${DEBVER}_source.changes" ) |
156 | git push origin "$RELBRANCH" | |
157 | git checkout master | |
baae6f7c | 158 | |
508cd1b3 XL |
159 | cat <<eof |
160 | Source-only re-release of $CRATE uploaded. You need to perform the following steps: | |
9550b9b4 | 161 | |
baae6f7c | 162 | eof |
508cd1b3 | 163 | |
baae6f7c | 164 | else |
508cd1b3 | 165 | |
64c6d382 FG |
166 | unstable_bin_packages="$(rmadison --noconf --suite unstable --source-and-binary "${DEBSRC}" | grep -v 'source$' | cut -d ' ' -f 1 | sort -u)" |
167 | upload_bin_packages="$(grep '^Binary' "build/${DEBSRC}_${DEBVER}.dsc" | sed -e 's/^Binary: //' -e 's/, /,/g' | tr ',' '\n' | sort -u)" | |
168 | diff_bin_packages="$(diff -u0 <(echo "$unstable_bin_packages") <(echo "$upload_bin_packages") | tail -n-2)" | |
169 | new_bin_packages="$(echo "$diff_bin_packages" | grep '^+' | sed -e 's/^+//g')" | |
170 | rm_bin_packages="$(echo "$diff_bin_packages" | grep '^-' | sed -e 's/^-//g')" | |
171 | ||
6b1bd07a XL |
172 | show_build_notice() { |
173 | cat <<eof | |
174 | The recommended way to build and upload is to run something like: | |
175 | ||
176 | cd build && ./build.sh $CRATE $VER && dput ${DEBSRC}_${DEBVER}_${DEB_HOST_ARCH}.changes | |
177 | eof | |
178 | } | |
179 | ||
baae6f7c | 180 | cat <<eof |
508cd1b3 XL |
181 | Release of $CRATE ready as a source package in ${BUILDDIR#$PWD/}. You need to |
182 | perform the following steps: | |
183 | ||
b6a1d240 XL |
184 | Build the package if necessary, and upload |
185 | ========================================== | |
64c6d382 FG |
186 | eof |
187 | ||
188 | if [ -z "$unstable_bin_packages" ]; then | |
189 | cat <<eof | |
2c47a4e5 | 190 | ${RED} |
64c6d382 FG |
191 | Since this is a NEW source package not already in the Debian archive, you will need to build a binary package out of it. |
192 | ||
193 | For your reference, this source package builds $(echo "$upload_bin_packages" | wc -l) binary package(s): | |
194 | $upload_bin_packages | |
2c47a4e5 | 195 | ${NC} |
64c6d382 | 196 | eof |
6b1bd07a | 197 | show_build_notice |
64c6d382 | 198 | |
6b1bd07a | 199 | elif [ -z "$new_bin_packages" ]; then |
64c6d382 FG |
200 | cat <<eof |
201 | Since the source package is already in Debian and this version does not introduce | |
1230b71f XL |
202 | new binaries, then you can just go ahead and directly dput the source package. |
203 | ||
1057693c | 204 | cd build && dput ${DEBSRC}_${DEBVER}_source.changes |
b6a1d240 | 205 | |
64c6d382 FG |
206 | For your reference, this source package builds $(echo "$upload_bin_packages" | wc -l) binary package(s): |
207 | $upload_bin_packages | |
208 | eof | |
6b1bd07a | 209 | # don't show build notice |
f52ac044 | 210 | |
64c6d382 | 211 | else |
64c6d382 | 212 | cat <<eof |
a4d317b5 | 213 | ${RED} |
64c6d382 FG |
214 | ATTENTION: this upload introduces NEW binary packages not already in the Debian |
215 | archive, you will need to build a binary package out of it. | |
216 | ||
217 | PLEASE THINK CAREFULLY BEFORE UPLOADING NEW VERSIONS WITH NEW BINARY PACKAGES, | |
218 | AS SUCH UPLOADS CAN AFFECT ONGOING TRANSITIONS AND DELAY THEM SIGNIFICANTLY. | |
219 | ||
220 | For your reference, this source package builds $(echo "$upload_bin_packages" | wc -l) binary package(s): | |
221 | $upload_bin_packages | |
222 | ||
223 | Of those, the following are NEW: | |
224 | $new_bin_packages | |
a4d317b5 | 225 | ${NC} |
64c6d382 | 226 | eof |
6b1bd07a | 227 | show_build_notice |
64c6d382 | 228 | |
6b1bd07a | 229 | fi # end decision-making on show_build_notice |
64c6d382 FG |
230 | |
231 | if [ -n "$rm_bin_packages" ]; then | |
232 | ||
233 | cat <<eof | |
234 | ||
235 | ATTENTION: The following binary packages which are currently available in | |
236 | Debian unstable are no longer built from ${DEBSRC}, please investigate whether | |
237 | this is intentional, and file RM requests where appropriate: | |
238 | ||
239 | $rm_bin_packages | |
240 | eof | |
241 | ||
242 | fi | |
243 | ||
244 | cat <<eof | |
c6709bfe XL |
245 | This assumes you followed the "Build environment" instructions in README.rst, |
246 | for setting up a build environment for release. | |
1230b71f | 247 | |
db9d5fab XL |
248 | If the build fails e.g. due to missing Build-Dependencies you should revert |
249 | what I did (see below) and package those missing Build-Dependencies first. | |
250 | ||
b6a1d240 XL |
251 | Push this pending-release branch |
252 | ================================ | |
253 | ||
254 | After you have uploaded the package with dput(1), you should push $RELBRANCH so | |
255 | that other people see it's been uploaded. Then, checkout another branch like | |
256 | master to continue development on other packages. | |
257 | ||
ea8e55fe | 258 | git push origin $RELBRANCH && git checkout master |
b6a1d240 | 259 | |
508cd1b3 XL |
260 | eof |
261 | ||
262 | fi | |
263 | ||
264 | cat >&2 <<eof | |
baae6f7c XL |
265 | Merge the pending-release branch if/when ACCEPTED |
266 | ================================================= | |
b6a1d240 XL |
267 | |
268 | When it's ACCEPTED by the Debian FTP masters, you may then merge this branch | |
269 | back into the master branch, delete it, and push these updates to origin. | |
270 | ||
ea8e55fe XL |
271 | git checkout master && git merge $RELBRANCH && git branch -d $RELBRANCH |
272 | git push origin master :$RELBRANCH | |
b6a1d240 | 273 | |
baae6f7c XL |
274 | Delete this branch without merging if/when REJECTED |
275 | =================================================== | |
b6a1d240 | 276 | |
baae6f7c XL |
277 | If your upload is REJECTED, or if you cannot perform an upload in the first |
278 | place e.g. because you are not a Debian Developer, you should revert what I | |
279 | just did. To do that, run: | |
b6a1d240 | 280 | |
ea8e55fe | 281 | git checkout master && git branch -D $RELBRANCH |
b6a1d240 | 282 | |
baae6f7c XL |
283 | Then ask a Debian Developer to re-run me ($0 $*) on your behalf. Also, touch |
284 | and commit ${PKGDIR_REL}/debian/RFS so we can track these easier. | |
1230b71f | 285 | eof |