跳至主要内容

管理存储库中的版本

你可以创建版本来捆绑和向用户交付项目的迭代。

谁可以使用此功能?

存储库协作者和具有存储库写访问权限的人员可以创建、编辑和删除版本。

关于版本管理

你可以创建带有版本说明、贡献者的 @ 提及和二进制文件链接的新版本,还可以编辑或删除现有版本。你还可以使用版本 API 创建、修改和删除版本。有关更多信息,请参阅 REST API 文档中的“版本 REST API 端点”。

你还可以从 GitHub Marketplace 中的特定版本发布操作。有关更多信息,请参阅“在 GitHub Marketplace 中发布操作”。

你可以选择是否将 Git 大型文件存储 (Git LFS) 对象包含在 GitHub 为每个版本创建的 ZIP 文件和 tarball 中。有关更多信息,请参阅“管理存储库存档中的 Git LFS 对象”。

创建版本

  1. 在 GitHub.com 上,导航到存储库的主页。

  2. 在文件列表右侧,单击版本

    Screenshot of the main page of a repository. A link, labeled "Releases", is highlighted with an orange outline.

  3. 在页面顶部,单击起草新版本

  4. 要为版本选择标签,请选择选择标签下拉菜单。

    • 要使用现有标签,请单击该标签。
    • 要创建新标签,请为版本键入版本号,然后单击创建新标签
  5. 如果你创建了新标签,请选择目标下拉菜单,然后单击包含你想要发布的项目的那个分支。

  6. 在描述字段上方,可以选择上一个标签下拉菜单,然后单击标识上一个版本的那个标签。

    Screenshot of the "New release" form. A dropdown menu, labeled "Previous tag: auto", is highlighted with an orange outline.

  7. 在“版本标题”字段中,为版本键入标题。

  8. 在“描述此版本”字段中,为版本键入描述。如果你在描述中 @ 提及任何人,已发布的版本将包含一个贡献者部分,其中列出所有被提及用户的头像。或者,你可以通过单击生成版本说明自动生成版本说明。

  9. 可以选择在二进制框中拖放或手动选择文件,以在版本中包含二进制文件,例如已编译程序。

  10. 可以选择选择这是预发布版本,以通知用户版本尚未准备好投入生产且可能不稳定。

  11. 可以选择选择设为最新版本。如果你不选择此选项,最新版本标签将根据语义版本控制自动分配。

  12. 可以选择在存储库中启用了 GitHub 讨论的情况下,为版本创建讨论。

    • 选择为该版本创建讨论
    • 选择类别下拉菜单,然后单击版本讨论的类别。
  13. 如果你已准备好公开你的版本,请单击发布版本。要稍后处理版本,请单击保存草稿。然后,你可以在存储库的版本动态中查看已发布或草稿版本。有关更多信息,请参阅“查看存储库的版本和标签”。

要了解有关 GitHub CLI 的更多信息,请参阅“关于 GitHub CLI”。

  1. 要创建版本,请使用 gh release create 子命令。将 tag 替换为版本所需的标记。

    gh release create TAG
    
  2. 按照交互式提示进行操作。或者,你可以指定参数来跳过这些提示。有关可能参数的详细信息,请参阅 GitHub CLI 手册。例如,此命令使用指定的标题和说明创建预发行版。

    gh release create v1.3.2 --title "v1.3.2 (beta)" --notes "this is a beta release" --prerelease
    

如果你在说明中 @ 提及任何 GitHub 用户,GitHub.com 上发布的版本将包括一个 贡献者 部分,其中包含所有被提及用户的头像列表。

编辑版本

  1. 在 GitHub.com 上,导航到存储库的主页。

  2. 在文件列表右侧,单击版本

    Screenshot of the main page of a repository. A link, labeled "Releases", is highlighted with an orange outline.

  3. 在要编辑的版本旁边,单击 .

    Screenshot of a release in the releases list. A pencil icon is highlighted with an orange outline.

  4. 在表单中编辑版本的详细信息,然后单击 更新版本。如果你在描述中添加或删除任何对 GitHub 用户的 @ 提及,这些用户将被添加到或从版本 贡献者 部分的头像列表中删除。

  1. 要编辑版本,请使用 gh release edit 子命令。将 TAG 替换为表示要编辑的版本的标记。例如,要编辑版本的标题,请使用以下代码,将 NEW-TITLE 替换为更新的标题

    gh release edit TAG -t "NEW-TITLE"
    

    有关可能参数的详细信息,请参阅 GitHub CLI 手册

删除版本

  1. 在 GitHub.com 上,导航到存储库的主页。

  2. 在文件列表右侧,单击版本

    Screenshot of the main page of a repository. A link, labeled "Releases", is highlighted with an orange outline.

  3. 在页面的右侧,在要删除的版本旁边,单击 .

    Screenshot of a release in the releases list. A trash icon is highlighted with an orange outline.

  4. 单击 删除此版本

  1. 要删除版本,请使用 gh release delete 子命令。将 tag 替换为要删除的版本的标记。使用 -y 标志跳过确认。

    gh release delete TAG -y