3 # git-debpush -- create & push a git tag with metadata for an ftp-master upload
5 # Copyright (C) 2019 Sean Whitton
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 set -e$DGIT_TEST_DEBPUSH_DEBUG
25 # - do not invoke dgit, do anything involving any tarballs, no network
26 # access except `git push` right at the end
28 # - do not look at the working tree, like `git push` `git tag`
30 # - we are always in split brain mode, because that fits this workflow,
31 # and avoids pushes failing just because dgit in the intermediary
32 # service wants to append commits
34 # - if there is no previous tag created by this script, require a quilt
35 # mode; if there is a previous tag, and no quilt mode provided, assume
36 # same quilt mode as in previous tag created by this script
38 # **** Helper functions and variables ****
41 git_playtree_setup=git-playtree-setup ###substituted###
42 git_playtree_setup=${DEBPUSH_GIT_PLAYTREE_SETUP-$git_playtree_setup}
45 if [ -d "$temp" ]; then
59 get_file_from_ref () {
62 # redirect to /dev/null instead of using `grep -Eq` to avoid grep
63 # SIGPIPEing git-ls-tree
64 if git ls-tree --name-only -r "$branch" \
65 | grep -E "^$path$" >/dev/null; then
66 git cat-file blob $branch:$path
73 local check_is_forced=false
76 *",$check,"*) check_is_forced=true ;;
78 if $force_all || $check_is_forced; then
79 echo >&2 "$us: warning: $* ('$check' check)"
81 echo >&2 "$us: $* ('$check' check)"
86 fail_check_upstream_nonidentical () {
87 fail_check upstream-nonidentical \
88 "the upstream source in tag $upstream_tag is not identical to the upstream source in $branch"
94 set +o pipefail # perl will SIGPIPE git-log(1) here
95 git log --pretty=format:'%D' --decorate=full "$branch" \
96 | perl -wne 'use Dpkg::Version;
97 @pieces = split /, /, $_;
98 @debian_tag_vs = sort { version_compare($b, $a) }
99 map { m|tag: refs/tags/'"$prefix"'(.+)| ? $1 : () } @pieces;
100 if (@debian_tag_vs) { print "'"$prefix"'$debian_tag_vs[0]\n"; exit }'
110 git diff --quiet --exit-code "$first".."$second" -- . "$@"
114 # show the user what the difference was
115 if [ $git_diff_rc = 1 ]; then
116 git diff --compact-summary "$first".."$second" -- . "$@"
119 if [ $git_diff_rc -le 1 ]; then
122 fail "'git diff' exited with unexpected code $git_diff_rc"
126 check_patches_apply () {
127 local should_match_branch="$1"
129 local playground="$(git rev-parse --git-dir)/gdp"
130 local playtree="$playground/apply-patches"
137 "$git_playtree_setup" .
139 # checking out the upstream source and then d/patches on top
140 # ensures this check will work for a variety of quilt modes
141 git checkout -b upstream "$upstream_committish"
142 git checkout "$branch_commit" -- debian
144 if [ -s "debian/patches/series" ]; then
146 shopt -s extglob; patch="${patch%%?( )#*}"; shopt -u extglob
147 if [ -z "$patch" ]; then continue; fi
149 git apply --index "debian/patches/$patch"
152 if ! [ $git_apply_rc = 0 ]; then
153 fail_check patches-applicable \
154 "'git apply' failed to apply patch $patch"
157 done <debian/patches/series
159 if $should_match_branch && [ $git_apply_rc = 0 ]; then
160 git commit -q -a -m"commit result of applying all patches"
161 check_treesame HEAD "$branch_commit" ':!debian' \
162 || fail_check patches-applicable \
163 "applying all patches does not yield $branch"
171 # **** Parse command line ****
173 getopt=$(getopt -s bash -o 'nfu:' \
174 -l 'no-push,force::,branch:,remote:,distro:,upstream:,quilt:,gbp,dpm,\
175 baredebian,baredebian+git,baredebian+tarball' \
178 set -e$DGIT_TEST_DEBPUSH_DEBUG
190 '-n'|'--no-push') pushing=false; shift; continue ;;
191 '-u') git_tag_opts+=(-u "$2"); shift 2; continue ;;
192 '-f') force_all=true; shift; continue ;;
193 '--gbp') quilt_mode='gbp'; shift; continue ;;
194 '--dpm') quilt_mode='dpm'; shift; continue ;;
195 '--branch') branch=$2; shift 2; continue ;;
196 '--remote') remote=$2; shift 2; continue ;;
197 '--distro') distro=$2; shift 2; continue ;;
198 '--quilt') quilt_mode=$2; shift 2; continue ;;
199 '--upstream') upstream_tag=$2; shift 2; continue ;;
201 '--baredebian'|'--baredebian+git')
202 quilt_mode=baredebian; shift; continue ;;
203 '--baredebian+tarball')
204 fail "--baredebian+tarball quilt mode not supported"
207 # we require the long form of the option to skip individual
208 # checks, not permitting `-f check`, to avoid problems if we
209 # later want to introduce positional args
219 '--') shift; break ;;
220 *) badusage "unknown option $1" ;;
225 badusage 'no positional arguments allowed'
228 case "$quilt_mode" in
229 linear|auto|smash|nofix|gbp|dpm|unapplied|baredebian|'') ;;
230 baredebian+git) quilt_mode="baredebian" ;;
231 baredebian+tarball) fail "--baredebian+tarball quilt mode not supported" ;;
232 *) badusage "invalid quilt mode: $quilt_mode" ;;
235 # **** Early sanity check ****
237 if [ "$branch" = "HEAD" ] \
238 && ! git symbolic-ref --quiet HEAD >/dev/null; then
239 fail_check detached \
240 "HEAD is detached; you probably don't want to debpush it"
243 # **** Gather git information ****
248 # Maybe $branch is a symbolic ref. If so, resolve it
249 branchref="$(git symbolic-ref -q $branch || test $? = 1)"
250 if [ "x$branchref" != "x" ]; then
253 # If $branch is the name of a branch but it does not start with
254 # 'refs/heads/', prepend 'refs/heads/', so that we can know later
255 # whether we are tagging a branch or some other kind of committish
259 branchref="$(git for-each-ref --format='%(objectname)' \
260 '[r]efs/heads/$branch')"
261 if [ "x$branchref" != "x" ]; then
262 branch="refs/heads/$branch"
267 # If our tag will point at a branch, push that branch, and add its
268 # pushRemote and remote to the things we'll check if the user didn't
272 b=${branch#refs/heads/}
274 remoteconfigs+=( branch.$b.pushRemote branch.$b.remote )
278 # resolve $branch to a commit
279 branch_commit="$(git rev-parse --verify ${branch}^{commit})"
281 # also check, if the branch does not have its own pushRemote or
282 # remote, whether there's a default push remote configured
283 remoteconfigs+=(remote.pushDefault)
285 if $pushing && [ "x$remote" = "x" ]; then
286 for c in "${remoteconfigs[@]}"; do
287 remote=$(git config "$c" || test $? = 1)
288 if [ "x$remote" != "x" ]; then break; fi
290 if [ "x$remote" = "x" ]; then
291 fail "pushing, but could not determine remote, so need --remote="
295 # **** Gather source package information ****
300 git cat-file blob "$branch":debian/changelog >"$temp/debian/changelog"
301 version=$(cd $temp; dpkg-parsechangelog -SVersion)
302 source=$(cd $temp; dpkg-parsechangelog -SSource)
303 target=$(cd $temp; dpkg-parsechangelog -SDistribution)
307 format="$(get_file_from_ref debian/source/format)"
309 '3.0 (quilt)') upstream=true ;;
310 '3.0 (native)') upstream=false ;;
312 if get_file_from_ref debian/source/options | grep -q '^-sn *$'; then
314 elif get_file_from_ref debian/source/options | grep -q '^-sk *$'; then
317 fail 'please see "SOURCE FORMAT 1.0" in git-debpush(1)'
321 fail "unsupported debian/source/format $format"
325 # **** Gather git history information ****
327 last_debian_tag=$(find_last_tag "debian/")
328 last_archive_tag=$(find_last_tag "archive/debian/")
332 if [ "x$upstream_tag" = x ]; then
335 git deborig --just-print --version="$version" \
337 ps="${PIPESTATUS[*]}"
340 "0 0"|"141 0") ;; # ok or SIGPIPE
343 "$us: git-deborig failed; maybe try $us --upstream=TAG"
346 *) exit 127; # presumably head will have complained
349 if [ "x$upstream_tag" = x ]; then exit 127; fi
351 upstream_committish=$(git rev-parse "refs/tags/${upstream_tag}"^{})
352 upstream_info=" upstream-tag=$upstream_tag upstream=$upstream_committish"
353 to_push+=("$upstream_tag")
356 # **** Useful sanity checks ****
358 # ---- UNRELEASED suite
360 if [ "$target" = "UNRELEASED" ]; then
361 fail_check unreleased "UNRELEASED changelog"
364 # ---- Pushing dgit view to maintainer view
366 if ! [ "x$last_debian_tag" = "x" ] && ! [ "x$last_archive_tag" = "x" ]; then
367 last_debian_tag_c=$(git rev-parse "$last_debian_tag"^{})
368 last_archive_tag_c=$(git rev-parse "$last_archive_tag"^{})
369 if ! [ "$last_debian_tag_c" = "$last_archive_tag_c" ] \
370 && git merge-base --is-ancestor \
371 "$last_debian_tag" "$last_archive_tag"; then
372 fail_check dgit-view \
373 "looks like you might be trying to push the dgit view to the maintainer branch?"
377 # ---- Targeting different suite
379 if ! [ "x$last_debian_tag" = "x" ]; then
383 git cat-file blob "$last_debian_tag":debian/changelog >"$temp/debian/changelog"
384 prev_target=$(cd $temp; dpkg-parsechangelog -SDistribution)
388 if ! [ "$prev_target" = "$target" ] && ! [ "$target" = "UNRELEASED" ]; then
390 "last upload targeted $prev_target, now targeting $target; might be a mistake?"
394 # ---- Upstream tag is not ancestor of $branch
396 if ! [ "x$upstream_tag" = "x" ] \
397 && ! git merge-base --is-ancestor "$upstream_tag" "$branch" \
398 && ! [ "$quilt_mode" = "baredebian" ]; then
399 fail_check upstream-nonancestor \
400 "upstream tag $upstream_tag is not an ancestor of $branch; probably a mistake"
403 # ---- Quilt mode-specific checks
405 case "$quilt_mode" in
407 check_treesame "$upstream_tag" "$branch" ':!debian' ':!**.gitignore' \
408 || fail_check_upstream_nonidentical
409 check_patches_apply false
412 check_treesame "$upstream_tag" "$branch" ':!debian' \
413 || fail_check_upstream_nonidentical
414 check_patches_apply false
417 check_patches_apply false
420 check_patches_apply true
424 # ---- git-debrebase branch format checks
426 # only check branches, since you can't run `git debrebase conclude` on
430 # see "STITCHING, PSEUDO-MERGES, FFQ RECORD" in git-debrebase(5)
431 ffq_prev_ref="refs/ffq-prev/${branch#refs/}"
432 if git show-ref --quiet --verify "$ffq_prev_ref"; then
433 fail_check unstitched \
434 "this looks like an unstitched git-debrebase branch, which should not be pushed"
440 if $failed_check; then
441 # We don't mention the --force=check options here as those are
442 # mainly for use by scripts, or when you already know what check
443 # is going to fail before you invoke git-debpush. Keep the
444 # script's terminal output as simple as possible. No "see the
446 fail "some check(s) failed; you can pass --force to ignore them"
449 # **** Create the git tag ****
451 # convert according to DEP-14 rules
452 git_version=$(echo $version | tr ':~' '%_' | sed 's/\.(?=\.|$|lock$)/.#/g')
454 debian_tag="$distro/$git_version"
455 to_push+=("$debian_tag")
457 # If the user didn't supply a quilt mode, look for it in a previous
458 # tag made by this script
459 if [ "x$quilt_mode" = "x" ] && [ "$format" = "3.0 (quilt)" ]; then
460 set +o pipefail # perl will SIGPIPE git-cat-file(1) here
461 if [ "x$last_debian_tag" != "x" ]; then
462 quilt_mode=$(git cat-file -p $(git rev-parse "$last_debian_tag") \
464 'm/^\[dgit.*--quilt=([a-z+]+).*\]$/;
465 if ($1) { print "$1\n"; exit }')
471 if [ "$format" = "3.0 (quilt)" ]; then
472 if [ "x$quilt_mode" = "x" ]; then
473 echo >&2 "$us: could not determine the git branch layout"
474 echo >&2 "$us: please supply a --quilt= argument"
477 quilt_mode_text=" --quilt=$quilt_mode"
481 tagmessage="$source release $version for $target
483 [dgit distro=$distro split$quilt_mode_text]
484 [dgit please-upload$upstream_info]
487 git tag "${git_tag_opts[@]}" -s -m "$tagmessage" "$debian_tag" "$branch"
489 # **** Do a git push ****
492 git push "$remote" "${to_push[@]}"