配置 GitHub 标记以组织存储库

已完成

GitHub 存储库中的标记旨在表示项目历史记录中特定点,例如指定的提交或发布版本。 通过向提交或发布的版本分配标记,开发人员可以创建项目开发的结构化时间线,以便能轻松跟踪并应用软件生命周期的重要里程碑。

规划

若要充分利用 GitHub 存储库中的标记来整理代码库,令其更容易导航和理解,请在规划部署工作时,考虑以下注意事项。

发布版本

根据版本标记特定的提交或发布。 按照语义版本控制表示法,这被广泛接受为标记软件版本的事实标准。 通常在版本名称前面添加字母v(例如,v1.0.0或v2.3.4)。 如果标记并不适用于生产用途,可以在版本名称后面添加预发行版本标记。(例如,v0.2.0-alpha 或 v5.9-beta.3)。 这有助于用户和协作者轻松区分稳定版本以及仍在测试阶段的功能。

功能版

标记引入新的功能或者对代码库进行重大更改的提交或合并。 使用“feature/new-login-page”或“feature/payment-integration”等描述性标记来突出显示特定的功能版本。 这些标记可以为功能添加提供清晰的历史记录,并帮助各个功能的长期开发进度。

缺陷修复

标记修复用户或协作者报告的 bug 或问题的提交或合并。 使用“bugfix/issue123”或“fix/critical-bug”等标记来表示 bug 修复版本。 Bug 修复标记可以轻松识别解决特定问题的提交,并确保此等修复可以在项目的不同版本中一致应用。

维护版本

标记涉及维护任务的提交或合并,例如代码重构、文档更新或依赖项升级。 使用“maintenance/code-refactor”或“update/documentation”等标记来标记维护版本。 维护发布标记有助于跟踪与代码维护相关的更改,确保正确记录并应用必要的更新。

自定义标记

创建自定义标记,根据组织的特定需求或工作流,对提交或发布进行分类。 例如,可以创建“文档”、“性能”或“安全”等标记,以便根据提交的重点区域对提交进行分类。 自定义标记可以为根据项目的要求组织和构建代码库提供额外的灵活性。

实施

若要将标记分配到 GitHub 中的 Git 存储库,可以按照以下步骤操作:

  1. 确定要在存储库中标记的特定提交或发布。 可以在存储库的提交历史记录或发布部分中找到提交哈希或发布版本。 如果要标记提交,请复制与要标记的提交关联的提交哈希。 如果要标记发布,请复制发布版本(例如,“v1.0.0”)。
  2. 在存储库的本地克隆中,使用 git 标记命令行创建标记。 创建语法的基本语法是git tag <tag_name><commit_hash>。 将 <tag_name> 替换为你的标记的称,然后将 <commit_hash> 替换为之前复制的提交哈希或发布版本。
  3. 通过运行 git push origin <tag_name> 命令将标记推送到 GitHub。 将 <tag_name> 替换为你创建的标记的名称。
  4. 推送标记后,可以通过导航到 GitHub 上的存储库的“发布”\“标记”页面来验证是否已成功创建该标记。

可以为存储库创建标记保护规则,防止参与者创建或删除标记。 但是,请记住,截至 2024 年 3 月,标记保护规则为 beta 版本,可能会更改。