From 8170d360d38f41dfd432061e71b3b81d21e24d35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Senart?= Date: Wed, 21 Nov 2018 17:29:01 +0100 Subject: [PATCH] Make git tag naming scheme compatible with `go mod` As reported in #357, only tags of the format `vMAJOR.MINOR.PATCH` are supported by `go mod`. This change set documents how we'll create tags in that format for library versions which will point to the same ref as the `lib/vMAJOR.MINOR.PATCH` tags. Fixes #357 --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 26038dcf..feab2bd3 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,8 @@ After [v8.0.0](https://github.com/tsenart/vegeta/tree/v8.0.0), the two component are versioned separately to better isolate breaking changes to each. CLI releases are tagged with `cli/vMAJOR.MINOR.PATCH` and published on the [Github releases page](https://github.com/tsenart/vegeta/releases). -As for the library, new versions are tagged with `lib/vMAJOR.MINOR.PATCH` but not published as a release. +As for the library, new versions are tagged with both `lib/vMAJOR.MINOR.PATCH` and `vMAJOR.MINOR.PATCH`. +The latter tag is required for compatibility with `go mod`. ## Contributing See [CONTRIBUTING.md](.github/CONTRIBUTING.md). @@ -519,6 +520,9 @@ The library versioning follows [SemVer v2.0.0](https://semver.org/spec/v2.0.0.ht Since [lib/v9.0.0](https://github.com/tsenart/vegeta/tree/lib/v9.0.0), the library and cli are versioned separately to better isolate breaking changes to each component. +See [Versioning](#Versioning) for more details on git tag naming schemes and compatibility +with `go mod`. + ```go package main