Is there a standard naming convention for git tags?

GitGit Tag

Git Problem Overview


I've seen a lot of projects using v1.2.3 as the naming convention for tags in git. I've also seen some use 1.2.3. Is there an officially endorsed style, or are there any good arguments for using either?

Git Solutions


Solution 1 - Git

Version 1.0.0 of Semantic Versioning, by Tom Preston-Werner of GitHub fame, had a sub-specification addressing this:

> Tagging Specification (SemVerTag) > > This sub-specification SHOULD be used if you use a version control system (Git, Mercurial, > SVN, etc) to store your code. Using this system allows automated tools to inspect your > package and determine SemVer compliance and released versions. > > 1. When tagging releases in a version control system, the tag for a version MUST be > "vX.Y.Z" e.g. "v3.1.0".

However, after discussion this was removed, and is no longer present in the latest version of the SemVer spec (2.0.0 at the time of writing). A later discussion thread in the same place went into greater depth, and resulted in a new Is "v1.2.3" a semantic version? being added to the FAQ in SemVer's master branch, although at the time of writing (over 2 years later) this change is still not present in the officially released spec.

Solution 2 - Git

There appear to be two dominating conventions (assuming you also abide by some reasonable standard for numbering the releases themselves):

  • v1.2.3
  • 1.2.3

The advantages of v1.2.3 are that the Git documentation (and also the Mercurial documentation) uses that format in its examples, and that several "authorities" such as the Linux kernel and Git itself use it. (The mentioned Semantic Versioning used to use it but doesn't any more.)

The advantages of 1.2.3 are that gitweb or GitHub can automatically offer a tarball or zip download of the form packagename-$tag.tar.gz (and I think it's quite established that a tarball should not be named package-v1.2.3.tar.gz). Alternatively, you can use git describe directly to generate tarball version numbers. For lightweight projects without a formal release process, these possibilities can be quite convenient. It should also be noted that Semantic Versioning is by no means the only or a universally accepted standard for version numbering. And notable projects such as GNOME as well as countless other projects do use the 1.2.3 tag naming.

I think it's probably too late to consolidate these positions. As always, be consistent and make sense.


Update: As mentioned in this comment, GitHub now offers a tarball name with the 'v' stripped off of the tag.

Solution 3 - Git

The reason for the preceding 'v' is historical. Older SCCS (cvs,rcs) could not distinguish between a tag identifier and a revision number. Tag identifiers were restricted to not begin with a numeric value so that revision numbers could be detected.

Solution 4 - Git

Not that I know of.
But Git will not allow a tag and a branch of the same name at the same time, so if you have a branch "1.1" for 1.1 works, do not put a tag "1.1", use for instance "v1.1"

Solution 5 - Git

New package managers advice to tag versions without prefix v (like composer for PHP projects). SemVer 2.0 has nothing about tag specification. It's done intentionally due avoiding conflicts. However it's advised to add prefix v in documentation and text references. As example format v1.0.4 instead of full version 1.0.4 or ver. 1.0.4 is enough verbose and elegant in documentation.

Solution 6 - Git

I don't know of any standards. I simply choose my tag names such that I can stick a

VERSION = `git describe --tags`

in my build scripts. So, the tag naming convention actually depends on the version naming convention of the project.

Solution 7 - Git

We use branches and tags for release-specific work followed by the actual release, respectively:

o---o-----o---o---o--- ...   master
     \   /       /
      \ /       /
       o-------o--- ...      1.6 branch

Every developer makes a mental decision about whether the work they're about to commit is applicable just to master or if it's also relevant to the branch. You can see that changes that are made to the branch are merged back on master, but some changes on master will never go on the branch (that is, those not intended for the 1.6 release, in this example).

When we're ready to release, we tag it and then merge back one last time, and we name the tag with the same name as the branch, but with an extra identifier about what particular version it is, e.g. "1.6-release" or "1.6-beta" or "1.6-rc2", et cetera.

... ------o---o---o--o---o--- ...   master
         /       /
        /       /
... ---o------(*)--- ...      1.6 branch
          1.6-release

Solution 8 - Git

There is no one best practice I'm aware of. Here are some links:

Generally, versioning (0.0.1, v0.2.1, ...) maybe hand in hand with some issue-tracking could be considered a plausible approach. (.. although I usually use v-prefixed tag names .. see also @VonC answer)

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestiontroelsknView Question on Stackoverflow
Solution 1 - GitperitusView Answer on Stackoverflow
Solution 2 - GitPeter EisentrautView Answer on Stackoverflow
Solution 3 - GitBill DoorView Answer on Stackoverflow
Solution 4 - GitVonCView Answer on Stackoverflow
Solution 5 - GitvitaliiView Answer on Stackoverflow
Solution 6 - GitJörg W MittagView Answer on Stackoverflow
Solution 7 - GitJohn FeminellaView Answer on Stackoverflow
Solution 8 - GitmikuView Answer on Stackoverflow