versions about gitchangelog HOT 5 CLOSED

Thanks for your interest.

gitchangelog uses tags set in your git repository (with git tag) as version number. You can filter unwanted tags and select those that should be used for changelog generation thanks to a regular expression (named tag_filter_regexp) that you can modifiy via the config file. (see .gitchangelog.rc). The provided default configuration will use only git tags that follows the convention "X.Y" or "X.Y.Z", with X, Y, and Z being numbers.

gitchangelog will start from current checked out commit (named also HEAD) and go down the history, following first-parent commits in case of merge commits that can have several parents. Whenever it encounters a tagged commit which tag name matches the tag_filter_regexp it'll use it as a version in the final changelog...

Do this answers your questions ? If yes, what part wasn't clear in the README.rst that I could improve ?
If this doesn't answer your question, could you be more specific on what information you try to get ?

NOTE: this answer was updated to try to be more clear. If this answers seems clear enough it'll be integrated in the README.rst

from gitchangelog.

ah i see. so it has to be added as (0.1.0) for instance at the end of the commit message to get the version to show up.

from gitchangelog.

Nope, please read documentation of git tag. Git changelog use them and won't parse the commit message to find tags.

I've edited my first answer to try to be more specific and clear. Please tell me if this is more clear for you now.

from gitchangelog.

ah i see. yes now it makes sense thanks. i just tried adding the v? on the regex and it seems to be working now.

from gitchangelog.

You're welcome. Thanks for your feedback.

from gitchangelog.