在版本控制环境中管理项目构建说明

Question

我们最近试图让我们的测试人员在发布新项目时更加清晰。

我们最初的想法是在项目中包含一个名为“BuildNotes”的Markdown文件（由源代码控制）。我们编辑markdown文件，然后生成一个他们可以阅读的html页面。

在文件中，我们在顶部有一个名为Build-Next的部分。因此，如果您正在完成用户故事，完成任务或完成错误，那么您可以在您的分支上的此部分中输入一个条目，然后通过PR合并到主分支。

e.g。

构建下一个

• BUG 1234按钮不起作用

构建-6

• User Story 5按钮点击保存文档。

现在当Branch被合并到develop中，然后下一个构建被推高。文档已更新，Build Next中的所有项目都会移动到新的构建部分，例如Build-7。

如果您正在处理1个任务，那么这项工作很有效，然后任务完成后再转到下一个任务。但是，如果你在他们自己的各个分支中处理多个小错误，并且有3/4分支坐等待PR，那么每次完成1个分支时你就会遇到持续的合并冲突，那么其他分支都会有与文件冲突，因为您始终更新Build Next部分。

还有其他方法可以做到这一点吗？我们可以使用Visual Studio中的Bugs / Tasks标记我们的PR，然后在构建中显示它们，但是我们经常在Build文档中添加自定义注释，以便测试人员知道要查找的内容。

Answer 1

对于存在于各个分支中的小错误，如果它们不相关，则可以单独构建它们。在构建定义中使用持续集成（CI）构建，因此每次分支合并到主分支时，都会触发构建。

如果这些错误是相关的，你应该解决冲突，直到所有PR合并到主分支，然后开始下一个构建。

Answer 2

恕我直言，你应该改变方法。您应该让构建过程生成构建文档文档作为工件，而不是单个版本控制的文档。例如，您可以使用很小的每分支注释（例如branch-note-BRANCH_NAME.md），并且构建只是将它们附加到不受版本控制的主文档（或存在于其自己的存储库中）。

你将有两个构建版本：一个在master上，将每个分支的注释文件连接到 Build Next 部分，另一个在开发中连接到 Build N 部分。您可以使用构建工具的某些API或在构建期间标记repo来选择构建标识符。