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
43 if [ -d "$temp" ]; then
57 get_file_from_ref () {
60 if git ls-tree --name-only -r "$branch" \
61 | grep -Eq "^$path$"; then
62 git cat-file blob $branch:$path
69 echo >&2 "$us: warning: $*"
79 set +o pipefail # perl will SIGPIPE git-log(1) here
80 git log --pretty=format:'%D' --decorate=full "$branch" \
81 | perl -wne 'use Dpkg::Version;
82 @pieces = split /, /, $_;
83 @debian_tag_vs = sort { version_compare($b, $a) }
84 map { m|tag: refs/tags/'"$prefix"'(.+)| ? $1 : () } @pieces;
85 if (@debian_tag_vs) { print "'"$prefix"'$debian_tag_vs[0]\n"; exit }'
89 # ---- Parse command line
91 getopt=$(getopt -s bash -o 'nfu:' \
92 -l 'no-push,force,branch:,remote:,distro:,upstream:,quilt:,gbp,dpm,\
93 baredebian,baredebian+git,baredebian+tarball' \
96 set -e$DGIT_TEST_DEBPUSH_DEBUG
107 '-n'|'--no-push') pushing=false; shift; continue ;;
108 '-u') git_tag_opts+=(-u "$2"); shift 2; continue ;;
109 '-f'|'--force') force=true; shift; continue ;;
110 '--gbp') quilt_mode='gbp'; shift; continue ;;
111 '--dpm') quilt_mode='dpm'; shift; continue ;;
112 '--branch') branch=$2; shift 2; continue ;;
113 '--remote') remote=$2; shift 2; continue ;;
114 '--distro') distro=$2; shift 2; continue ;;
115 '--quilt') quilt_mode=$2; shift 2; continue ;;
116 '--upstream') upstream_tag=$2; shift 2; continue ;;
118 '--baredebian'|'--baredebian+git')
119 quilt_mode=baredebian; shift; continue ;;
120 '--baredebian+tarball')
121 fail "--baredebian+tarball quilt mode not supported"
124 '--') shift; break ;;
125 *) badusage "unknown option $1" ;;
130 badusage 'no positional arguments allowed'
133 case "$quilt_mode" in
134 linear|auto|smash|nofix|gbp|dpm|unapplied|baredebian|'') ;;
135 baredebian+git) quilt_mode="baredebian" ;;
136 baredebian+tarball) fail "--baredebian+tarball quilt mode not supported" ;;
137 *) badusage "invalid quilt mode: $quilt_mode" ;;
140 # ---- Gather git information
145 # Maybe $branch is a symbolic ref. If so, resolve it
146 branchref="$(git symbolic-ref -q $branch || test $? = 1)"
147 if [ "x$branchref" != "x" ]; then
150 # If $branch is the name of a branch but it does not start with
151 # 'refs/heads/', prepend 'refs/heads/', so that we can know later
152 # whether we are tagging a branch or some other kind of committish
156 branchref="$(git for-each-ref --format='%(objectname)' \
157 '[r]efs/heads/$branch')"
158 if [ "x$branchref" != "x" ]; then
159 branch="refs/heads/$branch"
164 # If our tag will point at a branch, push that branch, and add its
165 # pushRemote and remote to the things we'll check if the user didn't
169 b=${branch#refs/heads/}
171 remoteconfigs+=( branch.$b.pushRemote branch.$b.remote )
175 # also check, if the branch does not have its own pushRemote or
176 # remote, whether there's a default push remote configured
177 remoteconfigs+=(remote.pushDefault)
179 if $pushing && [ "x$remote" = "x" ]; then
180 for c in "${remoteconfigs[@]}"; do
181 remote=$(git config "$c" || test $? = 1)
182 if [ "x$remote" != "x" ]; then break; fi
184 if [ "x$remote" = "x" ]; then
185 fail "pushing, but could not determine remote, so need --remote="
189 # ---- Gather source package information
194 git cat-file blob "$branch":debian/changelog >"$temp/debian/changelog"
195 version=$(cd $temp; dpkg-parsechangelog -SVersion)
196 source=$(cd $temp; dpkg-parsechangelog -SSource)
197 target=$(cd $temp; dpkg-parsechangelog -SDistribution)
201 format="$(get_file_from_ref debian/source/format)"
203 '3.0 (quilt)') upstream=true ;;
204 '3.0 (native)') upstream=false ;;
206 if get_file_from_ref debian/source/options | grep '^-sn *$'; then
208 elif get_file_from_ref debian/source/options | grep '^-sk *$'; then
211 fail 'please see "SOURCE FORMAT 1.0" in git-debpush(1)'
215 fail "unsupported debian/source/format $format"
219 # ---- Gather git history information
221 last_debian_tag=$(find_last_tag "debian/")
222 last_archive_tag=$(find_last_tag "archive/debian/")
226 if [ "x$upstream_tag" = x ]; then
229 git deborig --just-print --version="$version" \
231 ps="${PIPESTATUS[*]}"
234 "0 0"|"141 0") ;; # ok or SIGPIPE
237 "$us: git-deborig failed; maybe try $us --upstream=TAG"
240 *) exit 127; # presumably head will have complained
243 if [ "x$upstream_tag" = x ]; then exit 127; fi
245 upstream_committish=$(git rev-parse "refs/tags/${upstream_tag}"^{})
246 upstream_info=" upstream-tag=$upstream_tag upstream=$upstream_committish"
249 # ---- Useful sanity checks
251 if [ "$target" = "UNRELEASED" ]; then
252 fail_check "UNRELEASED changelog"
255 if ! [ "x$last_debian_tag" = "x" ] && ! [ "x$last_archive_tag" = "x" ]; then
256 last_debian_tag_c=$(git rev-parse "$last_debian_tag"^{})
257 last_archive_tag_c=$(git rev-parse "$last_archive_tag"^{})
258 if ! [ "$last_debian_tag_c" = "$last_archive_tag_c" ] \
259 && git merge-base --is-ancestor \
260 "$last_debian_tag" "$last_archive_tag"; then
262 "looks like you might be trying to push the dgit view to the maintainer branch?"
266 if ! [ "x$last_debian_tag" = "x" ]; then
270 git cat-file blob "$last_debian_tag":debian/changelog >"$temp/debian/changelog"
271 prev_target=$(cd $temp; dpkg-parsechangelog -SDistribution)
275 if ! [ "$prev_target" = "$target" ] && ! [ "$target" = "UNRELEASED" ]; then
277 "last upload targeted $prev_target, now targeting $target; might be a mistake?"
281 if ! [ "x$upstream_tag" = "x" ] \
282 && ! git merge-base --is-ancestor "$upstream_tag" "$branch" \
283 && ! [ "$quilt_mode" = "baredebian" ]; then
285 "upstream tag $upstream_tag is not an ancestor of $branch; probably a mistake"
289 if ! $force && $failed_check; then
290 fail "some checks failed; you can override with --force"
293 # ---- Create the git tag
295 # convert according to DEP-14 rules
296 git_version=$(echo $version | tr ':~' '%_' | sed 's/\.(?=\.|$|lock$)/.#/g')
298 debian_tag="$distro/$git_version"
300 # If the user didn't supply a quilt mode, look for it in a previous
301 # tag made by this script
302 if [ "x$quilt_mode" = "x" ] && [ "$format" = "3.0 (quilt)" ]; then
303 set +o pipefail # perl will SIGPIPE git-cat-file(1) here
304 if [ "x$last_debian_tag" != "x" ]; then
305 quilt_mode=$(git cat-file -p $(git rev-parse "$last_debian_tag") \
307 'm/^\[dgit.*--quilt=([a-z+]+).*\]$/;
308 if ($1) { print "$1\n"; exit }')
314 if [ "$format" = "3.0 (quilt)" ]; then
315 if [ "x$quilt_mode" = "x" ]; then
316 echo >&2 "$us: could not determine the git branch layout"
317 echo >&2 "$us: please supply a --quilt= argument"
320 quilt_mode_text=" --quilt=$quilt_mode"
324 git tag "${git_tag_opts[@]}" -s -F- "$debian_tag" "$branch" <<EOF
325 $source release $version for $target
327 [dgit distro=$distro split$quilt_mode_text]
328 [dgit please-upload$upstream_info]
334 if [ "x$upstream_tag" = "x" ]; then
335 git push "$remote" "${push_branch[@]}" "$debian_tag"
337 git push "$remote" "${push_branch[@]}" "$debian_tag" "$upstream_tag"