Add tag command

by splitting out the code from buildpackage

This is shorter than running

     gbp buildpackage --git-tag-only

Closes: #797086

1 files changed, 161 insertions, 0 deletions

diff --git a/gbp/scripts/tag.py b/gbp/scripts/tag.py
new file mode 100755
index 00000000..7cc93dab
--- /dev/null
+++ b/gbp/scripts/tag.py
@@ -0,0 +1,161 @@
+#!/usr/bin/python3
+# vim: set fileencoding=utf-8 :
+#
+# (C) 2017 Guido Günther <agx@sigxcpu.org>
+#    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 2 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, please see
+#    <http://www.gnu.org/licenses/>
+"""Create a Debian tag"""
+
+import os
+import sys
+
+import gbp.log
+from gbp.format import format_str
+from gbp.config import GbpOptionParserDebian
+from gbp.deb.git import DebianGitRepository, GitRepositoryError
+from gbp.deb.source import DebianSourceError
+from gbp.deb.source import DebianSource
+from gbp.errors import GbpError
+
+from gbp.scripts.common import ExitCodes
+from gbp.scripts.common.hook import Hook
+
+from gbp.scripts.common.pq import is_pq_branch, pq_branch_base
+
+
+def create_debian_tag(repo, source, commit, options):
+    """
+    Create the debian tag
+
+    returns: the created tag
+    """
+    tag = repo.version_to_tag(options.debian_tag, source.version)
+    gbp.log.info("Tagging %s as %s" % (source.version, tag))
+    if options.retag and repo.has_tag(tag):
+        repo.delete_tag(tag)
+    tag_msg = format_str(options.debian_tag_msg,
+                         dict(pkg=source.sourcepkg,
+                              version=source.version))
+    repo.create_tag(name=tag,
+                    msg=tag_msg,
+                    sign=options.sign_tags,
+                    commit=commit,
+                    keyid=options.keyid)
+    return tag
+
+
+def perform_tagging(repo, source, options, hook_env=None):
+    """
+    Perform the tagging
+
+    Select brach to tag, create tag and run hooks
+    """
+    branch = repo.branch
+    if branch and is_pq_branch(branch):
+        commit = repo.get_merge_base(branch, pq_branch_base(branch))
+    else:
+        commit = repo.head
+
+    tag = create_debian_tag(repo, source, commit, options)
+    if options.posttag:
+        sha = repo.rev_parse("%s^{}" % tag)
+        Hook('Posttag', options.posttag,
+             extra_env=Hook.md(hook_env or {},
+                               {'GBP_TAG': tag,
+                                'GBP_BRANCH': branch or '(no branch)',
+                                'GBP_SHA1': sha})
+             )()
+
+
+def build_parser(name):
+    try:
+        parser = GbpOptionParserDebian(command=os.path.basename(name),
+                                       usage='%prog [options]')
+    except GbpError as err:
+        gbp.log.err(err)
+        return None
+
+    parser.add_option("--retag", action="store_true", dest="retag", default=False,
+                      help="don't fail if the tag already exists")
+    parser.add_config_file_option(option_name="debian-branch",
+                                  dest="debian_branch")
+    parser.add_config_file_option(option_name="debian-tag",
+                                  dest="debian_tag")
+    parser.add_config_file_option(option_name="debian-tag-msg", dest="debian_tag_msg")
+    parser.add_boolean_config_file_option(option_name="sign-tags", dest="sign_tags")
+    parser.add_config_file_option(option_name="keyid", dest="keyid")
+    parser.add_config_file_option(option_name="posttag", dest="posttag",
+                                  help="hook run after a successful tag operation, "
+                                  "default is '%(posttag)s'")
+    parser.add_boolean_config_file_option(option_name="ignore-branch", dest="ignore_branch")
+    parser.add_boolean_config_file_option(option_name="ignore-new", dest="ignore_new")
+    parser.add_config_file_option(option_name="color", dest="color", type='tristate')
+    parser.add_config_file_option(option_name="color-scheme",
+                                  dest="color_scheme")
+    parser.add_option("--verbose", action="store_true", dest="verbose",
+                      default=False, help="verbose command execution")
+    return parser
+
+
+def parse_args(argv):
+    parser = build_parser(argv[0])
+    if not parser:
+        return None, None
+    return parser.parse_args(argv)
+
+
+def main(argv):
+    retval = 1
+
+    (options, args) = parse_args(argv)
+    if not options:
+        return ExitCodes.parse_error
+
+    gbp.log.setup(options.color, options.verbose, options.color_scheme)
+    try:
+        repo = DebianGitRepository(os.path.curdir, toplevel=False)
+    except GitRepositoryError:
+        gbp.log.err("%s is not inside a git repository" % (os.path.abspath('.')))
+        return 1
+
+    try:
+        source = DebianSource(repo.path)
+        if not (options.ignore_branch or options.ignore_new):
+            if repo.branch != options.debian_branch:
+                gbp.log.err("You are not on branch '%s' but on '%s'"
+                            % (options.debian_branch,
+                               repo.branch or 'no branch'))
+                raise GbpError("Use --ignore-branch to ignore or "
+                               "--debian-branch to set the branch name.")
+
+        if not options.ignore_new:
+            (ret, out) = repo.is_clean()
+            if not ret:
+                gbp.log.err("You have uncommitted changes in your source tree:")
+                gbp.log.err(out)
+                raise GbpError("Use --ignore-new to ignore.")
+
+        perform_tagging(repo, source, options)
+        retval = 0
+    except (GbpError, GitRepositoryError, DebianSourceError) as err:
+        if str(err):
+            gbp.log.err(err)
+
+    return retval
+
+
+if __name__ == '__main__':
+    sys.exit(main(sys.argv))
+
+# vim:et:ts=4:sw=4:et:sts=4:ai:set list listchars=tab\:»·,trail\:·: