引言

此文章是系列文章的第 3 部分。

• 第 1 部分 — 使用 Go 模块
• 第二部分 — 迁移到 Go 模块
• 第 3 部分 — 发布 Go 模块（此文章）
• 第四部分 — Go 模块：v2 及更高版本
• 第五部分 — 保持模块兼容

注意： 有关开发模块的文档，请参阅 开发和发布模块。

此文章讨论如何编写和发布模块，以便其他模块可以依赖它们。

请注意：此文章涵盖了从开发到 v1 的内容。如果您对 v2 感兴趣，请参阅Go 模块：v2 及更高版本。

此文章在示例中使用 Git。也支持 Mercurial、Bazaar 和其他版本控制系统。

项目设置

对于此文章，您需要一个现有的项目作为示例。因此，从使用 Go 模块文章末尾的文件开始。

$ cat go.mod
module example.com/hello

go 1.12

require rsc.io/quote/v3 v3.1.0

$ cat go.sum
golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c h1:qgOY6WgZOaTkIIMiVjBQcw93ERBE4m30iBm00nkL0i8=
golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
rsc.io/quote/v3 v3.1.0 h1:9JKUTTIUgS6kzR9mK1YuGKv6Nl+DijDNIc0ghT58FaY=
rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=
rsc.io/sampler v1.3.0 h1:7uVkIFmeBqHfdjD+gZwtXXI+RODJ2Wc4O7MPEh/QiW4=
rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=

$ cat hello.go
package hello

import "rsc.io/quote/v3"

func Hello() string {
    return quote.HelloV3()
}

func Proverb() string {
    return quote.Concurrency()
}

$ cat hello_test.go
package hello

import (
    "testing"
)

func TestHello(t *testing.T) {
    want := "Hello, world."
    if got := Hello(); got != want {
        t.Errorf("Hello() = %q, want %q", got, want)
    }
}

func TestProverb(t *testing.T) {
    want := "Concurrency is not parallelism."
    if got := Proverb(); got != want {
        t.Errorf("Proverb() = %q, want %q", got, want)
    }
}

$

接下来，创建一个新的 git 仓库并添加初始提交。如果您要发布自己的项目，请务必包含 LICENSE 文件。切换到包含 go.mod 的目录，然后创建仓库。

$ git init
$ git add LICENSE go.mod go.sum hello.go hello_test.go
$ git commit -m "hello: initial commit"
$

语义化版本和模块

go.mod 中每个必需的模块都有一个语义化版本，即用于构建模块的该依赖项的最低版本。

语义化版本具有 vMAJOR.MINOR.PATCH 的形式。

• 当您对模块的公共 API 进行向后不兼容的更改时，请增加 MAJOR 版本。这只应在绝对必要时进行。
• 当您对 API 进行向后兼容的更改时，请增加 MINOR 版本，例如更改依赖项或添加新的函数、方法、结构体字段或类型。
• 在进行不影响模块公共 API 或依赖项的次要更改（例如修复错误）后，请增加 PATCH 版本。

您可以通过附加连字符和点分隔的标识符来指定预发布版本（例如，v1.0.1-alpha 或 v2.2.2-beta.2）。go 命令优先于预发布版本选择正常版本，因此如果您的模块有任何正常版本，用户必须明确要求预发布版本（例如，go get example.com/hello@v1.0.1-alpha）。

v0 主要版本和预发布版本不保证向后兼容性。它们允许您在向用户做出稳定性承诺之前完善您的 API。但是，v1 主要版本及更高版本要求在该主要版本内向后兼容。

go.mod 中引用的版本可以是仓库中标记的明确发布版本（例如，v1.5.2），也可以是基于特定提交的伪版本（例如，v0.0.0-20170915032832-14c0d48ead0c）。伪版本是一种特殊类型的预发布版本。当用户需要依赖尚未发布任何语义版本标签的项目，或针对尚未标记的提交进行开发时，伪版本很有用，但用户不应假定伪版本提供了稳定或经过充分测试的 API。使用明确版本标记您的模块向用户表明特定版本已通过充分测试并可供使用。

一旦您开始使用版本标记您的仓库，在开发模块时继续标记新版本就很重要。当用户请求您的模块的新版本时（使用 go get -u 或 go get example.com/hello），go 命令将选择可用的最大语义发布版本，即使该版本已存在多年并且落后于主分支的许多更改。继续标记新版本将使您的持续改进可供用户使用。

不要从您的仓库中删除版本标签。如果您发现某个版本存在错误或安全问题，请发布新版本。如果人们依赖于您已删除的版本，他们的构建可能会失败。同样，一旦发布版本，请勿更改或覆盖它。模块镜像和校验和数据库存储模块、其版本和签名的加密哈希，以确保给定版本的构建随着时间的推移保持可重现性。

v0：初始不稳定版本

让我们用 v0 语义版本标记模块。v0 版本不提供任何稳定性保证，因此几乎所有项目在完善其公共 API 时都应从 v0 开始。

标记新版本有几个步骤。

1. 运行 go mod tidy，它会删除模块可能积累的不再需要的任何依赖项。

2. 最后运行一次 go test ./... 以确保一切正常。

3. 使用 git tag 标记项目的新版本。

4. 将新标签推送到原始仓库。

$ go mod tidy
$ go test ./...
ok      example.com/hello       0.015s
$ git add go.mod go.sum hello.go hello_test.go
$ git commit -m "hello: changes for v0.1.0"
$ git tag v0.1.0
$ git push origin v0.1.0
$

现在其他项目可以依赖 example.com/hello 的 v0.1.0。对于您自己的模块，您可以运行 go list -m example.com/hello@v0.1.0 来确认最新版本是否可用（此示例模块不存在，因此没有版本可用）。如果您没有立即看到最新版本并且您正在使用 Go 模块代理（Go 1.13 以来的默认设置），请在几分钟后重试，以便代理有时间加载新版本。

如果您添加到公共 API，对 v0 模块进行破坏性更改，或升级其中一个依赖项的次要版本或版本，请为您的下一个版本增加 MINOR 版本。例如，v0.1.0 之后的下一个版本将是 v0.2.0。

如果您修复了现有版本中的错误，请增加 PATCH 版本。例如，v0.1.0 之后的下一个版本将是 v0.1.1。

v1：第一个稳定版本

一旦您绝对确定模块的 API 稳定，您就可以发布 v1.0.0。v1 主要版本向用户表明不会对模块的 API 进行不兼容的更改。他们可以升级到新的 v1 次要版本和补丁版本，并且他们的代码不应中断。函数和方法签名不会更改，导出的类型不会被删除，等等。如果 API 发生更改，它们将是向后兼容的（例如，向结构体添加新字段），并将包含在新次要版本中。如果存在错误修复（例如，安全修复），它们将包含在补丁版本中（或作为次要版本的一部分）。

有时，保持向后兼容性可能会导致笨拙的 API。没关系。不完美的 API 优于破坏用户现有代码。

标准库的 strings 包是维护向后兼容性（以 API 一致性为代价）的一个典型示例。

• Split 将字符串切片为由分隔符分隔的所有子字符串，并返回这些分隔符之间的子字符串切片。
• SplitN 可用于控制返回的子字符串数量。

然而，Replace 接受要从开头替换多少个字符串实例的计数（与 Split 不同）。

给定 Split 和 SplitN，您会期望像 Replace 和 ReplaceN 这样的函数。但是，我们不能在不破坏调用者的情况下更改现有的 Replace，我们承诺不会这样做。因此，在 Go 1.12 中，我们添加了一个新函数 ReplaceAll。最终的 API 有点奇怪，因为 Split 和 Replace 的行为不同，但这种不一致性优于破坏性更改。

假设您对 example.com/hello 的 API 感到满意，并且希望将 v1 作为第一个稳定版本发布。

标记 v1 使用与标记 v0 版本相同的过程：运行 go mod tidy 和 go test ./...，标记版本，并将标签推送到原始仓库。

$ go mod tidy
$ go test ./...
ok      example.com/hello       0.015s
$ git add go.mod go.sum hello.go hello_test.go
$ git commit -m "hello: changes for v1.0.0"
$ git tag v1.0.0
$ git push origin v1.0.0
$

至此，example.com/hello 的 v1 API 已固化。这向所有人表明我们的 API 是稳定的，他们应该放心使用它。

结论

此文章介绍了使用语义版本标记模块以及何时发布 v1 的过程。未来的文章将介绍如何在 v2 及更高版本中维护和发布模块。

要提供反馈并帮助塑造 Go 中依赖管理的未来，请向我们发送错误报告或经验报告。

感谢您的所有反馈和帮助改进 Go 模块。