Allow creating annotated tags #58

ekohl · 2014-10-09T09:02:49Z

When creating annotated tags (by passing a message into them), you can use "git describe".

ekohl · 2014-10-09T09:04:46Z

bumpversion/__init__.py

@@ -181,7 +184,8 @@ def add_path(cls, path):
        pass

    @classmethod
-    def tag(cls, name):
+    def tag(cls, name, message):
+        # TODO: use message?


I appears mercurial has no concept of annotated tags, so maybe throw an error if one is passed instead of silently ignoring it?

True, but it looks like you can still add a message to a tag?

hg tag v1.0.0 -m "Finally v1.0.0"

ekohl · 2014-10-21T21:43:37Z

@peritus ping

peritus · 2014-10-22T09:06:20Z

tests.py

+        describe_out = subprocess.call([vcs, "describe"])
+        assert 128 == describe_out
+
+    main(['patch', '--current-version', '42.3.2', '--commit', '--tag', 'VERSION', '--tag-message', 'test {new_version}-tag'])


This is a second test, please split.

peritus · 2014-10-22T09:07:20Z

Needs docs, needs a test using a configuration file.

ekohl · 2014-10-22T09:12:14Z

The docs would go in README?

peritus · 2014-10-22T09:18:08Z

Sorry, yes, "docs". README it is ;)

ekohl · 2015-01-02T15:02:39Z

I reworked the tests so they also cover mercurial where appropriate. If you think it's alright then I'll update README as well.

ekohl · 2015-01-02T15:24:18Z

Btw, since I discovered that git describe --tags does what I want, my need for this has decreased. However, I do want to finish this.

jgilchrist · 2015-09-15T19:31:56Z

What's left to do on this before it can be merged?

ekohl · 2015-09-15T21:25:20Z

I think a rebase, a review and docs in README.

ekohl · 2015-09-15T21:29:08Z

Rebased

peritus · 2015-11-09T16:35:00Z

bumpversion/__init__.py

+    def tag(cls, name, message):
+        command = ["git", "tag", name]
+        if message:
+            command += ['-m', message]


Should be using --message, because it's clearer.

peritus · 2015-11-09T16:45:55Z

I really like the straightforwardness (is that even a word?) of this pull request, it just does the one thing it says on the box.

However, I'd really like "annotated commits" to be the default, that is, bumpversion should make annotated commits without users configuring that specifically because they know about annotated commits and they know that they're important.

That being said, tag_message = should have a nice default, similar to how message = (which would then be commit_message =, to avoid confusion) has a nice, recognizable default (compare

bumpversion/bumpversion/__init__.py

Line 784 in 6ec908f

    
           default=defaults.get('message', 'Bump version: {current_version} → {new_version}'))

)

peritus · 2015-11-09T16:47:49Z

Also, what's common practice regarding information to include in annotated tags ? If there are any pointers to blog posts etc. describing what people put in them when releasing, now's the time.

gst · 2015-11-19T18:34:10Z

@peritus I agree with you for the use of annotated tags by default.
For what they should include as information I would point you to this SO answer : http://stackoverflow.com/a/4971817/2451329

basically what they contains for the annotation itself, by default, is not that important, what's important is that with annotated tag you know who has submitted it and when it was done.
So I'd suggest simply put the same value as the tag value itself..

By the way : I'm waiting for this PR quite actively, I've a project where I work and we switched to gerrit code review and it requires annotated tags.. So for now I'm a bit stuck with current bumpversion ..

thanks.

cmeeren · 2015-11-19T18:51:11Z

@gst as a workaround you can tag manually (you can configure bumpversion not to tag the commits)

ekohl · 2015-11-20T08:19:44Z

I will have a look at rebasing + addressing the comments this weekend.

gst · 2015-11-24T17:13:05Z

@cmeeren thx for the tip, effectively, integrated in my .bumpversion.cfg :)

@gvangool

When creating annotated tags (by passing a message into them), you can use "git describe". This is based on work by @gvangool.

ekohl · 2015-11-25T09:03:08Z

@gst Thanks for the reminder :)

Updated. It now has a default tag message (can be disabled by passing an empty string) and passes --message to git/hg instead of -m.

kynan · 2016-02-15T23:05:16Z

@peritus Can this please be merged? I was about to implement this feature myself, glad I checked first :)

If the sticking point is docs I'll be happy to pr those once this is in.

kynan · 2016-02-15T23:11:56Z

Relates to #74

NOTE: due to missing support for annotated tags in bumpversion, this requires https://github.com/ekohl/bumpversion@annotated-tags: pip install git+https://github.com/ekohl/bumpversion@annotated-tags See also peritus/bumpversion#58

schechter · 2016-03-16T19:39:10Z

Can this feature be added please. We running into issues because bumpversion is not making annotated tags.

MarcMeszaros · 2016-04-04T21:01:32Z

Any timeline on when this is being merged in? It would also help us.

dbrgn · 2016-04-12T06:31:26Z

Any news on this, now that Github actually shows signatures?

nehalecky · 2016-04-19T17:41:59Z

We really enjoy using bumpversion, but really need to have this feature added. When can we expect it?

schechter · 2016-05-18T17:24:35Z

@peritus Is there anything additional you want in this PR? I'm sure someone would do it if you let us know what you think it missing.

anthrotype · 2016-10-11T12:03:31Z

+1

anthrotype · 2016-10-11T22:47:28Z

Apologies for my insistence. I know there are more important things in life than annotated git tags.
However, this little change would make a lot of difference for my workflow.
I just noticed the last commit to master was more than a year ago. May I ask if this package is still maintained? I see it's being used by major projects, like setuptools for example...
Anyway, thanks for this great tool!

I had to remove the comments because bumpversion will strip them out anyway upon re-writing the updated version string in setup.cfg file. Similarly, I had to normalize the whitespace like bumpversion would do. :-/ `tag=True` option means a tag is automatically created when bumping the version with bumpversion script. However, in order to get 'annotated' instead of 'lightweight' tags -- i.e. the tag also contains the tag author, date and message --, we need to (temporarily?) use a fork of bumpversion that includes an unmerged PR: peritus/bumpversion#58

jobevers · 2016-10-14T21:04:21Z

+1 on annotated tags

jaraco · 2016-12-03T15:20:26Z

I'd like to see this feature as I use bumpversion for tagging setuptools releases, and without annotated tags, I have to remember to dual push (git push and git push --tags), whereas with annotated tags, I can rely on the followTags option to ensure that my tags are pushed.

JamshedVesuna · 2016-12-22T06:59:55Z

+1

c4urself · 2017-03-27T20:40:23Z

I was hoping that this would've been merged by now, unfortunately, it doesn't look like this repo is being actively maintained. In the interim, I've forked the project and named it bump2version (to reduce conflicts and allow a push to pypi). This version allows annotated tags support. I'm happy to change the README to point back to this repo if development resumes!

anthrotype · 2017-03-27T20:42:14Z

maybe we should consider proposing bumpversion to https://jazzband.co/

ekohl · 2017-03-28T10:15:17Z

For the lazy people like me a clickable link: https://github.com/c4urself/bump2version

@c4urself I considered forking myself but didn't want to commit myself to it and couldn't come up with a name. I like bump2version.

@anthrotype It may be a good but that still requires @peritus to transfer the repository.

ulope · 2017-03-28T12:54:47Z

@c4urself Awesome. Thanks for taking this on. Could you enable Issues in your fork?

c4urself · 2017-03-28T18:36:36Z

@ulope -- done
@ekohl -- want to join as a contributor?
@anthrotype -- i like that idea as well but contacted @peritus who suggested that a fork was the way to go for now

ekohl · 2017-03-28T18:43:58Z

@c4urself Done.

It would be nice if @peritus would officially endorse the fork, for example by making a note in the README both on github and pypi.

The original bumpversion is no longer maintained, this is the new blessed fork peritus/bumpversion#58 (comment) https://github.com/c4urself/bump2version https://pypi.python.org/pypi/bump2version/0.5.5 Annotated tags, e.g. `git tag -am "blah blah"`, can have a message, record the date and the name of the tagger, and work with git `describe`.

ekohl · 2018-10-11T13:31:15Z

Closing because bump2version has been available for quite a while.

NOTE: due to missing support for annotated tags in bumpversion, this requires https://github.com/ekohl/bumpversion@annotated-tags: pip install git+https://github.com/ekohl/bumpversion@annotated-tags See also peritus/bumpversion#58

ekohl force-pushed the annotated-tags branch from bda784e to 716d117 Compare October 9, 2014 09:03

ekohl mentioned this pull request Oct 9, 2014

Create annotated, signed tags #2

Open

ekohl reviewed Oct 9, 2014
View reviewed changes

ekohl force-pushed the annotated-tags branch from 716d117 to 5baf005 Compare October 9, 2014 09:28

peritus reviewed Oct 22, 2014
View reviewed changes

ekohl force-pushed the annotated-tags branch from 5baf005 to c1ffcfc Compare January 2, 2015 15:01

ekohl force-pushed the annotated-tags branch from c1ffcfc to 3d2ce79 Compare January 2, 2015 15:26

ekohl force-pushed the annotated-tags branch from 3d2ce79 to 89e6efa Compare September 15, 2015 21:28

cmeeren mentioned this pull request Oct 8, 2015

Use annotated tags #116

Closed

peritus reviewed Nov 9, 2015
View reviewed changes

Allow creating annotated tags

ee9d4d4

When creating annotated tags (by passing a message into them), you can use "git describe". This is based on work by @gvangool.

ekohl force-pushed the annotated-tags branch from 89e6efa to ee9d4d4 Compare November 25, 2015 09:01

kynan mentioned this pull request Feb 15, 2016

Support for signed tags #74

Open

kynan mentioned this pull request Feb 15, 2016

Version information kynan/nbstripout#12

Closed

ryneeverett mentioned this pull request Mar 1, 2016

Allow setting tag message with $EDITOR. ekohl/bumpversion#1

Closed

luzfcb mentioned this pull request Apr 24, 2017

Setup bumpversion cookiecutter/cookiecutter-django#1062

Closed

ekohl mentioned this pull request Sep 5, 2017

Use -m option of git tag #159

Open

ekohl closed this Oct 11, 2018

ekohl deleted the annotated-tags branch October 11, 2018 13:31

Allow creating annotated tags #58

Allow creating annotated tags #58

Conversation

ekohl commented Oct 9, 2014

ekohl Oct 9, 2014

Choose a reason for hiding this comment

gvangool Oct 9, 2014

Choose a reason for hiding this comment

ekohl Oct 9, 2014

Choose a reason for hiding this comment

ekohl commented Oct 21, 2014

peritus Oct 22, 2014

Choose a reason for hiding this comment

peritus commented Oct 22, 2014

ekohl commented Oct 22, 2014

peritus commented Oct 22, 2014

ekohl commented Jan 2, 2015

ekohl commented Jan 2, 2015

jgilchrist commented Sep 15, 2015

ekohl commented Sep 15, 2015

ekohl commented Sep 15, 2015

peritus Nov 9, 2015

Choose a reason for hiding this comment

peritus commented Nov 9, 2015

peritus commented Nov 9, 2015

gst commented Nov 19, 2015

cmeeren commented Nov 19, 2015

ekohl commented Nov 20, 2015

gst commented Nov 24, 2015

ekohl commented Nov 25, 2015

kynan commented Feb 15, 2016

kynan commented Feb 15, 2016

schechter commented Mar 16, 2016

MarcMeszaros commented Apr 4, 2016

dbrgn commented Apr 12, 2016

nehalecky commented Apr 19, 2016

schechter commented May 18, 2016

anthrotype commented Oct 11, 2016

anthrotype commented Oct 11, 2016

jobevers commented Oct 14, 2016

jaraco commented Dec 3, 2016

JamshedVesuna commented Dec 22, 2016

c4urself commented Mar 27, 2017

anthrotype commented Mar 27, 2017

ekohl commented Mar 28, 2017

ulope commented Mar 28, 2017

c4urself commented Mar 28, 2017

ekohl commented Mar 28, 2017

ekohl commented Oct 11, 2018