summaryrefslogtreecommitdiff
path: root/git-debpush
blob: 63057ed24ee3334c3cfc4dd0d5d35bcc3cdec1ef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
#!/bin/bash

# git-debpush -- create & push a git tag with metadata for an ftp-master upload
#
# Copyright (C) 2019 Sean Whitton
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

set -e$DGIT_TEST_DEBPUSH_DEBUG
set -o pipefail

# DESIGN PRINCIPLES
#
# - do not invoke dgit, do anything involving any tarballs, no network
#   access except `git push` right at the end
#
# - do not look at the working tree, like `git push` `git tag`
#
# - we are always in split brain mode, because that fits this workflow,
#   and avoids pushes failing just because dgit in the intermediary
#   service wants to append commits
#
# - if there is no previous tag created by this script, require a quilt
#   mode; if there is a previous tag, and no quilt mode provided, assume
#   same quilt mode as in previous tag created by this script

# ---- Helper functions and variables

us="$(basename $0)"

cleanup() {
    if [ -d "$temp" ]; then
        rm -rf "$temp"
    fi
}

fail () {
    echo >&2 "$us: $*";
    exit 127;
}

badusage () {
    fail "bad usage: $*";
}

get_file_from_ref () {
    local path=$1

    if git ls-tree --name-only -r "$branch" \
            | grep -Eq "^$path$"; then
        git cat-file blob $branch:$path
    fi
}

# ---- Parse command line

getopt=$(getopt -s bash -o 'nfu:' \
              -l 'no-push,force,branch:,remote:,distro:,upstream:,quilt:,gbp,dpm,\
baredebian,baredebian+git,baredebian+tarball' \
              -n "$us" -- "$@")
eval "set - $getopt"
set -e$DGIT_TEST_DEBPUSH_DEBUG

git_tag_opts=()
pushing=true
force=false
distro=debian
quilt_mode=""
branch="HEAD"

while true; do
    case "$1" in
        '-n'|'--no-push') pushing=false;           shift;   continue ;;
	'-u')             git_tag_opts+=(-u "$2"); shift 2; continue ;;
        '-f'|'--force')   force=true;              shift;   continue ;;
        '--gbp')          quilt_mode='gbp';        shift;   continue ;;
        '--dpm')          quilt_mode='dpm';        shift;   continue ;;
        '--branch')       branch=$2;               shift 2; continue ;;
        '--remote')       remote=$2;               shift 2; continue ;;
        '--distro')       distro=$2;               shift 2; continue ;;
        '--quilt')        quilt_mode=$2;           shift 2; continue ;;
        '--upstream')     upstream_tag=$2;         shift 2; continue ;;

        '--baredebian'|'--baredebian+git')
            quilt_mode=baredebian;         shift; continue ;;
        '--baredebian+tarball')
            fail "--baredebian+tarball quilt mode not supported"
            ;;

        '--') shift; break ;;
	*) badusage "unknown option $1" ;;
    esac
done

if [ $# != 0 ]; then
    badusage 'no positional arguments allowed'
fi

case "$quilt_mode" in
    linear|auto|smash|nofix|gbp|dpm|unapplied|baredebian|'') ;;
    baredebian+git) quilt_mode="baredebian" ;;
    baredebian+tarball) fail "--baredebian+tarball quilt mode not supported" ;;
    *) badusage "invalid quilt mode: $quilt_mode" ;;
esac

# ---- Gather git information

remoteconfigs=()
push_branch=()

# Maybe $branch is a symbolic ref.  If so, resolve it
branchref="$(git symbolic-ref -q $branch || test $? = 1)"
if [ "x$branchref" != "x" ]; then
   branch="$branchref"
fi
# If $branch is the name of a branch but it does not start with
# 'refs/heads/', prepend 'refs/heads/', so that we can know later
# whether we are tagging a branch or some other kind of committish
case "$branch" in
    refs/heads/*) ;;
    *)
        branchref="$(git for-each-ref --format='%(objectname)' \
                         '[r]efs/heads/$branch')"
        if [ "x$branchref" != "x" ]; then
            branch="refs/heads/$branch"
        fi
        ;;
esac

# If our tag will point at a branch, push that branch, and add its
# pushRemote and remote to the things we'll check if the user didn't
# supply a remote
case "$branch" in
    refs/heads/*)
        b=${branch#refs/heads/}
        push_branch+=("$b")
        remoteconfigs+=( branch.$b.pushRemote branch.$b.remote )
        ;;
esac

# also check, if the branch does not have its own pushRemote or
# remote, whether there's a default push remote configured
remoteconfigs+=(remote.pushDefault)

if $pushing && [ "x$remote" = "x" ]; then
    for c in "${remoteconfigs[@]}"; do
	remote=$(git config "$c" || test $? = 1)
	if [ "x$remote" != "x" ]; then break; fi
    done
    if [ "x$remote" = "x" ]; then
	fail "pushing, but could not determine remote, so need --remote="
    fi
fi

# ---- Gather source package information

temp=$(mktemp -d)
trap cleanup EXIT
mkdir "$temp/debian"
git cat-file blob "$branch":debian/changelog >"$temp/debian/changelog"
version=$(cd $temp; dpkg-parsechangelog -SVersion)
source=$(cd $temp; dpkg-parsechangelog -SSource)
target=$(cd $temp; dpkg-parsechangelog -SDistribution)
rm -rf "$temp"
trap - EXIT

# ---- Useful sanity checks

if ! $force; then

    if [ "$target" = "UNRELEASED" ]; then
        fail "UNRELEASED changelog"
    fi

    # TODO additional checks we might do:
    #
    # - are we uploading to a different suite from the last tag
    #   (e.g. unstable after experimental)?  user should pass option to
    #   confirm
    #
    # - walking backwards from $branch, if there is an archive/ strictly
    #   before we reach most recent debian/ tag, error, this might be a
    #   push of the dgit view to the maintainer branch

fi

# ---- Create the git tag

format="$(get_file_from_ref debian/source/format)"
case "$format" in
    '3.0 (quilt)')  upstream=true ;;
    '3.0 (native)') upstream=false ;;
    '1.0'|'')
	if get_file_from_ref debian/source/options | grep '^-sn *$'; then
	    upstream=false
        elif get_file_from_ref debian/source/options | grep '^-sk *$'; then
	    upstream=true
	else
	    fail 'please see "SOURCE FORMAT 1.0" in git-debpush(1)'
	fi
	;;
    *)
	fail "unsupported debian/source/format $format"
	;;
esac

upstream_info=""
if $upstream; then
    if [ "x$upstream_tag" = x ]; then
	upstream_tag=$(
	    set +e
	    git deborig --just-print --version="$version" \
			   | head -n1
	    ps="${PIPESTATUS[*]}"
	    set -e
	    case "$ps" in
		"0 0"|"141 0") ;; # ok or SIGPIPE
		*" 0")
		    echo >&2 \
 "$us: git-deborig failed; maybe try $us --upstream=TAG"
		    exit 0
		    ;;
		*) exit 127; # presumably head will have complained
	    esac
	)
	if [ "x$upstream_tag" = x ]; then exit 127; fi
    fi
    upstream_committish=$(git rev-parse "refs/tags/${upstream_tag}"^{})
    upstream_info=" upstream-tag=$upstream_tag upstream=$upstream_committish"
fi

# convert according to DEP-14 rules
git_version=$(echo $version | tr ':~' '%_' | sed 's/\.(?=\.|$|lock$)/.#/g')

debian_tag="$distro/$git_version"

# If the user didn't supply a quilt mode, look for it in a previous
# tag made by this script
if [ "x$quilt_mode" = "x" ] && [ "$format" = "3.0 (quilt)" ]; then
    set +o pipefail             # perl will SIGPIPE git-log(1) here
    tag=$(git log --pretty=format:'%D' --decorate=full "$branch" \
        | perl -wne 'use Dpkg::Version;
        	@pieces = split /, /, $_;
        	@debian_tag_vs = sort {version_compare($b, $a)}
                    map { m|tag: refs/tags/debian/(.+)| ? $1 : () } @pieces;
        	if (@debian_tag_vs) { print "debian/$debian_tag_vs[0]\n"; exit }')
    if [ "x$tag" != "x" ]; then
        quilt_mode=$(git cat-file -p $(git rev-parse "$tag") \
                         | perl -wne \
                                'm/^\[dgit.*--quilt=([a-z+]+).*\]$/;
                                 if ($1) { print "$1\n"; exit }')
    fi
    set -o pipefail
fi

quilt_mode_text=""
if [ "$format" = "3.0 (quilt)" ]; then
    if [ "x$quilt_mode" = "x" ]; then
        echo >&2 "$us: could not determine the git branch layout"
        echo >&2 "$us: please supply a --quilt= argument"
        exit 1
    else
        quilt_mode_text=" --quilt=$quilt_mode"
    fi
fi

git tag "${git_tag_opts[@]}" -s -F- "$debian_tag" "$branch" <<EOF
$source release $version for $target

[dgit distro=$distro split$quilt_mode_text]
[dgit please-upload$upstream_info]
EOF

# ---- Do a git push

if $pushing; then
    # xxx when user can specify upstream_tag, must cope with spaces
    git push "$remote" "${push_branch[@]}" $upstream_tag "$debian_tag"
fi