跳至主要内容

在仓库中管理发布

您可以创建发布来捆绑和交付项目的迭代版本给用户。

谁可以使用此功能?

仓库协作者和对仓库具有写入权限的人员可以创建、编辑和删除发布。

关于发布管理

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

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

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

创建版本

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

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

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

  3. 在页面顶部,点击创建新版本草稿

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

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

  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 Discussions,请为版本创建讨论。

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

要了解有关 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 public preview release" --prerelease
    

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

编辑版本

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

  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 上,导航到存储库的主页面。

  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