3 ### Build script for Debian packages
5 ### (c) 2008 Mark Wooding
8 ###----- Licensing notice ---------------------------------------------------
10 ### This program is free software; you can redistribute it and/or modify
11 ### it under the terms of the GNU General Public License as published by
12 ### the Free Software Foundation; either version 2 of the License, or
13 ### (at your option) any later version.
15 ### This program is distributed in the hope that it will be useful,
16 ### but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ### GNU General Public License for more details.
20 ### You should have received a copy of the GNU General Public License
21 ### along with this program; if not, write to the Free Software Foundation,
22 ### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 ###--------------------------------------------------------------------------
25 ### Conventions for build systems.
27 ### This script is designed to work with a variety of `make'-based build
28 ### systems, but there are a number of conventions which must be followed if
29 ### this is going to work properly.
31 ### * There must be a `configure.ac', `configure.in', or `.links' file, or
32 ### a `.git' directory in the project top-level, so that we can find it.
34 ### * The following `make' variables must be assigned in the top-level
35 ### Makefile, after `mdw-build' has constructed it.
37 ### distdir The name of the top-level project directory in the
38 ### source distribution, and the base name for
39 ### distribution archives; should be of the form
40 ### `PROJECT-VERSION'.
42 ### The following `make' targets must be available in the top-level
45 ### dist Write to $(distdir).tar.gz a source distribution of
48 ### distcheck As for `dist', but also build and test the project.
50 ### * The source distribution constructed by `make dist' must contain a file
51 ### $(distdir)/RELEASE containing the release name. This isn't currently
52 ### tested, but it might be later.
56 ###--------------------------------------------------------------------------
59 unset checkout checkoutrev
62 unset sbuild sbuildsrv
63 unset upload uploadpath
65 unset build distcheck debian clean vpath native
67 "/etc/mdw-build.conf" \
68 "${XDG_CONFIG_HOME-$HOME/.config}/mdw-build.conf" \
71 if [ -f "$i" ]; then . "$i"; fi
75 eval "p=\${$var+t} q=\${$want+t}"
76 case $p,$q in t,*) ;; *,t) eval "$var=yes" ;; *) eval "$var=no" ;; esac
78 : ${checkout=yes} ${checkoutrev=HEAD}
80 : ${setup=yes} ${setupcmd=mdw-setup}
87 default_depends sbuild sbuildsrv
88 default_depends sign signkey
89 default_depends upload uploadpath
90 default_depends dput dputtarget
91 : ${DEB_BUILD_OPTIONS=parallel=4}; export DEB_BUILD_OPTIONS
93 ###--------------------------------------------------------------------------
100 Usage: $prog [-v] BUILDOPT
109 [no]upload[=SERVER:PATH]
120 ## Parse simple options.
122 while getopts "hv" opt; do
129 shift $((OPTIND - 1))
131 ## Parse the build options.
134 eval "p=\${$want+t}\${$want-nil}"
137 nil) echo >&2 "$prog: $want not set"; exit 1 ;;
142 checkout) checkout=yes checkoutrev=HEAD ;;
143 checkout=*) checkout=yes checkoutrev=${opt#*=} ;;
144 release) build=release ;;
145 norelease) build=test ;;
146 setup) setup=yes setupcmd=mdw-setup ;;
147 setup=*) setup=yes setupcmd=${opt#*=} ;;
148 upload) maybe_set upload uploadpath ;;
149 upload=*) upload=yes uploadpath=${opt#*=} ;;
150 sign) maybe_set sign signkey ;;
151 sign=*) sign=yes signkey=${opt#*=} ;;
152 sbuild) maybe_set sbuild sbuildsrv ;;
153 sbuild=*) sbuild=yes sbuildsrv=${opt#*=} ;;
154 dput) maybe_set dput dputtarget ;;
155 dput=*) dput=yes dputtarget=${opt#*=} ;;
156 make=*) make=${opt#*=} ;;
158 distcheck | debian | clean | vpath | native)
161 nocheckout | nosetup | nodistcheck | nodebian | \
162 noupload | nodput | noclean | novpath | nonative | nosbuild | nosign)
172 ## Parse DEB_BUILD_OPTIONS.
174 set -- $DEB_BUILD_OPTIONS
177 parallel=*) jobs=${opt#*=} ;;
182 case $jobs in 1) ;; *) makeopts="$makeopts -j$jobs" ;; esac
184 ###--------------------------------------------------------------------------
185 ### Utility functions.
187 ## File descriptor assignments:
189 ## 0 -- original stdin (never touched)
190 ## 1, 2 -- stdout, stderr, redirected to 3 while running comamnds
191 ## log -- original stderr (verbose), or logfile (quiet); captures command
193 ## diag -- null (verbose), or logfile (quiet); primary diagnostic output
194 ## term -- orginal stderr; secondary diagnostic output (with colours)
196 exec {log}>&2 {diag}>/dev/null {term}>&2
200 echo $message >&$diag
201 echo "$(tput bold; tput setaf $colour)$message$(tput sgr0; tput op)" >&$term
211 release) fail "$*" ;;
212 *) notify 5 "??? $*" ;;
227 nice "$@" 2>&$log {log}>&- {diag}>&- {term}>&- || fail "$1: exit $?"
230 run () { runx "$@" >&$log; }
233 echo -n "(test $*)" >&$diag
234 if "$@" >&$diag 2>&$diag {log}>&- {diag}>&- {term}>&-; then
243 ###--------------------------------------------------------------------------
246 ## Find the top-level package directory.
247 while [ ! -f configure.ac -a ! -f configure.in -a \
248 ! -f .links -a ! -d .git ]; do
251 fail "couldn't find top-level directory"
258 ## Build any necessary qualifiers.
260 case ${SBOX_SESSION_DIR+t},${DEB_BUILD_ARCH+t} in
261 t,t) qual=$qual$sep$DEB_BUILD_ARCH; sep=- ;;
262 t,*) fail "unknown build arch" ;;
265 ## Construct the output directory.
266 releasepath=$toppath/dist-$build$qual
267 chmod -R +w $releasepath 2>/dev/null || :
268 rm -rf $releasepath 2>/dev/null || :
272 exec {log}>&- {diag}>&-
273 exec {diag}>$releasepath/mdw-build.log {log}>&$diag ||
274 fail "Failed to create log."
278 ## Repeat the earlier assignments for tbe benefit of the logfile.
279 assign toppath $toppath
280 assign releasepath $releasepath
282 ## Do we have a Git repository?
283 case "$checkout,$setup,$(yesno [ -d $toppath/.git ])" in
285 fail "Inconsistent options: can't check out without setup."
288 info "No Git repository found."
289 checkout=no gitver=none
293 [ "$(git ls-files -m)" = "" ] ||
294 warn "working tree has uncommitted changes"
298 ## Is there Debian build equipment?
299 case "$debian,$(yesno [ -d $toppath/debian ])" in
301 info "No debian directory found."
302 debian=no debver=none
308 debver=$(dpkg-parsechangelog | sed -n 's/^Version: //p')
309 debsrc=$(dpkg-parsechangelog | sed -n 's/^Source: //p')
310 debname=$(git config user.name) debemail=$(git config user.email)
314 ## Maybe check out a copy of the source.
318 run git clone -sn $toppath/.git _source
319 assign srcpath $releasepath/_source
321 run git update-ref refs/heads/mdw-build $checkoutrev ""
322 run git symbolic-ref HEAD refs/heads/mdw-build
323 run git read-tree --reset refs/heads/mdw-build
324 run git checkout-index -afu
325 assign gitversion "$(git describe --abbrev=4)"
328 assign srcpath $toppath
332 ## Check the version number.
334 case "$gitversion,$debver" in
338 dvref=$(echo "$debver" | tr '~' '_')
339 if [ "$gitversion" = "$dvref" ]; then
340 assign debversion "$debver"
342 warn "Git version $gitversion doesn't match Debian version $debver"
344 dver=$(echo $gitversion | sed 's/-/+/; s/-/./g')
345 case $debver in *~) dver=$debver$dver ;; esac
346 assign debversion "$dver"
352 ## Maybe refresh the build machinery.
359 ## Initialize the build directory.
360 case "$vpath,$(yesno [ -e $srcpath/configure ])" in
362 assign buildpath $releasepath/_build
365 run $srcpath/configure
368 info "VPATH build disabled"
369 assign buildpath $srcpath
375 info "no configure script"
376 assign buildpath $srcpath
381 ## Discover the release name.
382 cat >find-distdir.mk <<'EOF'
385 @echo >&$(fd) $(distdir)
388 $({ $make -f find-distdir.mk print-distdir fd=$t >/dev/null 2>&1; } {t}>&1)
390 ## Get a tarball distribution.
393 run $make $makeopts distcheck
396 run $make $makeopts dist
404 if ! tar tf $buildpath/$distdir.tar.gz 2>/dev/null | grep -q RELEASE
406 fail "missing RELEASE file in distribution"
411 run mv $buildpath/$distdir.tar.gz .
414 run gpg -u$signkey -ab -o$distdir.tar.gz.gpg $distdir.tar.gz
418 ## Maybe build the Debian packages.
421 run tar xvfz $distdir.tar.gz
425 cat - debian/changelog >debian/changelog.new <<EOF
426 $debsrc ($debversion) experimental; urgency=low
428 * Hacking in process, not intended for release.
430 -- $debname <$debemail> $now
433 mv debian/changelog.new debian/changelog
436 sbuildargs=$sbuildsrv
437 case $sbuild,$build in
439 case $sign in yes) sbuildargs="-k$signkey $sbuildargs" ;; esac
442 if [ -d $toppath/dist-$build.pkgs ]; then
443 sbuildargs="-p$toppath/dist-$build.pkgs $sbuildargs"
447 case $sbuild,$build,$sign in
448 yes,*) run mdw-sbuild $sbuildargs ;;
449 no,release,yes) run dpkg-buildpackage -k$signkey ;;
450 no,*) run dpkg-buildpackage -us -uc ;;
455 ## Maybe upload Debian packages.
457 case "$upload,$build" in
458 yes,test) info "Test build: not uploading." ;;
459 yes,release) run rsync $distdir.tar.gz $distdir.tar.gz.gpg $uploadpath ;;
461 case "$debian,$upload,$dput,$build" in
462 yes,yes,yes,release) run dput -f $dputtarget *.changes ;;
468 rm -rf $releasepath/$distdir
469 rm -rf $releasepath/_source
470 rm -rf $releasepath/_build
477 ###----- That's all, folks --------------------------------------------------