Skip to content

Allow creating annotated tags #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ekohl wants to merge 1 commit into from
Closed

Allow creating annotated tags #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions bumpversion/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,11 @@ def add_path(cls, path):
subprocess.check_output(["git", "add", "--update", path])

@classmethod
def tag(cls, name):
subprocess.check_output(["git", "tag", name])
def tag(cls, name, message):
command = ["git", "tag", name]
if message:
command += ['--message', message]
subprocess.check_output(command)


class Mercurial(BaseVCS):
Expand Down Expand Up @@ -180,8 +183,11 @@ def add_path(cls, path):
pass

@classmethod
def tag(cls, name):
subprocess.check_output(["hg", "tag", name])
def tag(cls, name, message):
command = ["hg", "tag", name]
if message:
command += ['--message', message]
subprocess.check_output(command)

VCS = [Git, Mercurial]

Expand Down Expand Up @@ -490,6 +496,7 @@ def serialize(self, version, context):
'--search',
'--replace',
'--tag-name',
'--tag-message',
'-m'
]

Expand Down Expand Up @@ -779,11 +786,13 @@ def main(original_args=None):
help='Tag name (only works with --tag)',
default=defaults.get('tag_name', 'v{new_version}'))

parser3.add_argument('--tag-message', metavar='TAG_MESSAGE', dest='tag_message',
help='Tag message', default=defaults.get('tag_message', 'Bump version: {current_version} → {new_version}'))

parser3.add_argument('--message', '-m', metavar='COMMIT_MSG',
help='Commit message',
default=defaults.get('message', 'Bump version: {current_version} → {new_version}'))


file_names = []
if 'files' in defaults:
assert defaults['files'] != None
Expand Down Expand Up @@ -913,12 +922,13 @@ def main(original_args=None):
vcs.commit(message=commit_message)

tag_name = args.tag_name.format(**vcs_context)
logger.info("{} '{}' in {}".format(
tag_message = args.tag_message.format(**vcs_context)
logger.info("{} '{}' {} in {}".format(
"Would tag" if not do_tag else "Tagging",
tag_name,
"with message '{}'".format(tag_message) if tag_message else "without message",
vcs.__name__
))

if do_tag:
vcs.tag(tag_name)

vcs.tag(tag_name, tag_message)
82 changes: 80 additions & 2 deletions tests/test_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ def _mock_calls_to_string(called_mock):
[--commit | --no-commit]
[--tag | --no-tag]
[--tag-name TAG_NAME]
[--tag-message TAG_MESSAGE]
[--message COMMIT_MSG]
part
[file [file ...]]
Expand Down Expand Up @@ -120,6 +121,9 @@ def _mock_calls_to_string(called_mock):
--no-tag Do not create a tag in version control
--tag-name TAG_NAME Tag name (only works with --tag) (default:
v{new_version})
--tag-message TAG_MESSAGE
Tag message (default: Bump version: {current_version}
→ {new_version})
--message COMMIT_MSG, -m COMMIT_MSG
Commit message (default: Bump version:
{current_version} → {new_version})
Expand Down Expand Up @@ -734,6 +738,80 @@ def test_message_from_config_file(tmpdir, capsys, vcs):

assert b'from-400.0.0-to-401.0.0' in tag_out


@pytest.mark.parametrize(("vcs"), [xfail_if_no_git("git"), xfail_if_no_hg("hg")])
def test_unannotated_tag(tmpdir, vcs):
tmpdir.chdir()
check_call([vcs, "init"])
tmpdir.join("VERSION").write("42.3.1")
check_call([vcs, "add", "VERSION"])
check_call([vcs, "commit", "-m", "initial commit"])

main(['patch', '--current-version', '42.3.1', '--commit', '--tag', 'VERSION', '--tag-name', 'ReleasedVersion-{new_version}', '--tag-message', ''])

tag_out = check_output([vcs, {"git": "tag", "hg": "tags"}[vcs]])
assert b'ReleasedVersion-42.3.2' in tag_out

if vcs == "git":
describe_out = subprocess.call([vcs, "describe"])
assert 128 == describe_out

describe_out = subprocess.check_output([vcs, "describe", "--tags"])
assert describe_out.startswith(b'ReleasedVersion-42.3.2')


@pytest.mark.parametrize(("vcs"), [xfail_if_no_git("git"), xfail_if_no_hg("hg")])
def test_annotated_tag(tmpdir, vcs):
tmpdir.chdir()
check_call([vcs, "init"])
tmpdir.join("VERSION").write("42.4.1")
check_call([vcs, "add", "VERSION"])
check_call([vcs, "commit", "-m", "initial commit"])

main(['patch', '--current-version', '42.4.1', '--commit', '--tag', 'VERSION', '--tag-message', 'test {new_version}-tag'])
assert '42.4.2' == tmpdir.join("VERSION").read()

tag_out = check_output([vcs, {"git": "tag", "hg": "tags"}[vcs]])
assert b'v42.4.2' in tag_out

if vcs == "git":
describe_out = subprocess.check_output([vcs, "describe"])
assert describe_out == b'v42.4.2\n'

describe_out = subprocess.check_output([vcs, "show", "v42.4.2"])
assert describe_out.startswith(b"tag v42.4.2\n")
assert b'test 42.4.2-tag' in describe_out
elif vcs == "hg":
describe_out = subprocess.check_output([vcs, "log"])
assert b'test 42.4.2-tag' in describe_out
else:
raise ValueError("Unknown VCS")


@pytest.mark.parametrize(("vcs"), [xfail_if_no_git("git")])
def test_vcs_describe(tmpdir, vcs):
tmpdir.chdir()
check_call([vcs, "init"])
tmpdir.join("VERSION").write("42.5.1")
check_call([vcs, "add", "VERSION"])
check_call([vcs, "commit", "-m", "initial commit"])

main(['patch', '--current-version', '42.5.1', '--commit', '--tag', 'VERSION', '--tag-message', 'test {new_version}-tag'])
assert '42.5.2' == tmpdir.join("VERSION").read()

describe_out = subprocess.check_output([vcs, "describe"])
assert b'v42.5.2\n' == describe_out

main(['patch', '--current-version', '42.5.2', '--commit', '--tag', 'VERSION', '--tag-name', 'ReleasedVersion-{new_version}', '--tag-message', ''])
assert '42.5.3' == tmpdir.join("VERSION").read()

describe_only_annotated_out = subprocess.check_output([vcs, "describe"])
assert describe_only_annotated_out.startswith(b'v42.5.2-1-g')

describe_all_out = subprocess.check_output([vcs, "describe", "--tags"])
assert b'ReleasedVersion-42.5.3\n' == describe_all_out


config_parser_handles_utf8 = True
try:
import configparser
Expand Down Expand Up @@ -1083,7 +1161,7 @@ def test_subjunctive_dry_run_logging(tmpdir, vcs):
info|Would add changes in file 'dont_touch_me.txt' to Git|
info|Would add changes in file '.bumpversion.cfg' to Git|
info|Would commit to Git with message 'Bump version: 0.8 \u2192 0.8.1'|
info|Would tag 'v0.8.1' in Git|
info|Would tag 'v0.8.1' with message 'Bump version: 0.8 \u2192 0.8.1' in Git|
""").strip()

if vcs == "hg":
Expand Down Expand Up @@ -1149,7 +1227,7 @@ def test_log_commitmessage_if_no_commit_tag_but_usable_vcs(tmpdir, vcs):
info|Would add changes in file 'please_touch_me.txt' to Git|
info|Would add changes in file '.bumpversion.cfg' to Git|
info|Would commit to Git with message 'Bump version: 0.3.3 \u2192 0.3.4'|
info|Would tag 'v0.3.4' in Git|
info|Would tag 'v0.3.4' with message 'Bump version: 0.3.3 \u2192 0.3.4' in Git|
""").strip()

if vcs == "hg":
Expand Down