docs

Author: linkdata

README.md

@@ -5,7 +5,7 @@
 
 # gitsemver
 
-Build a [semver](https://semver.org/) compliant version string for a git repository.
+Build a SemVer-inspired version string for a git repository.
 
 Using tree hashes it returns the latest matching semver tag. If no tree hash
 match exactly, it falls back to the latest semver tag reachable from the
@@ -21,6 +21,11 @@ Supports raw git repositories as well as GitLab and GitHub builders.
 
 `gitsemver` is a CLI-first tool, one process run per repository.
 
+Tag matching is intentionally relaxed: `vMAJOR`, `vMAJOR.MINOR`, and
+`vMAJOR.MINOR.PATCH` (and the same forms without `v`) are all accepted and
+preserved in output. If you require strict SemVer 2.0.0 output, use full
+`MAJOR.MINOR.PATCH` tags in Git.
+
 The implementation package is intentionally internal to this module and is not a
 supported external API.
 If reused anyway, create a new `GitSemVer` instance per version lookup

internal/gitsemver/gitter.go

@@ -154,6 +154,8 @@ func (dg DefaultGitter) CheckGitRepo(dir string) (repo string, err error) {
 	return
 }
 
+// Intentionally accepts partial numeric tags (v1, v1.2, v1.2.3),
+// with or without a leading "v".
 var reMatchSemver = regexp.MustCompile(`^v?[0-9]+(?:\.[0-9]+)?(?:\.[0-9]+)?$`)
 
 // GetTags returns all tags, sorted by version descending.