TeamCity On-Premises 2024.03 Help

创建和编辑构建配置

这一部分包含了如何通过 TeamCity UI 创建和配置构建配置的文章。

构建配置 是用于启动构建并在 UI 中组织构建序列的设置集合。 构建配置的示例包括分发集成测试准备发行版分发"夜间"构建
构建配置属于一个项目并包含构建。 您可以在其主页探索构建配置的详细信息,并在设置页面修改其设置。

创建构建配置

建议为每个构建序列(即在专用环境中执行指定任务)设置单独的构建配置。 这允许适当的功能正常运行,如新问题/失败测试的检测,首次失败/修复测试的状态,自动删除的调查等等。

要处理增加的构建配置数量,您可以使用 构建配置模板 和项目级别的 参数

这个视频教程说明了如何在 TeamCity 中使用构建配置,并提供了一些额外的提示:

在哪里创建构建配置

要找到构建配置创建向导:

  1. 前往 Administration | Projects (管理 | 项目)并打开所需的项目。
    或者,利用 Projects (项目)弹出菜单来打开项目并点击 Edit Project Settings(编辑项目设置)。
    Project Settings (项目设置)页面将会打开。

  2. Project Settings (项目设置)页面,点击 Build Configurations (构建配置)部分下的 Create build configuration(创建构建配置)。

  3. 请根据您选择的方法遵循特定的说明:

从仓库 URL 创建构建配置

在创建构建配置后,您可以:

从网址创建构建配置

构建配置创建向导 中:

  1. 点击 From a repository URL(从仓库URL)

  2. 输入您的 VCS 仓库 URL ,如果需要身份验证,请输入 VCS 凭证(用户名和密码 / 令牌)。

  3. 点击 Create

TeamCity 会建议构建配置名称,并为您配置其余的设置:

  • 它将确定 VCS 仓库的类型,并创建一个 VCS root。 对于 Git 仓库,它将自动检测默认分支。 您现在或稍后有选项在 VCS root 设置中进行更改。 您也可以改变分支规格:默认情况下,TeamCity 会监视存储库的所有分支,但您可以通过输入 自定义规则 来选择需要监视的确切分支。

  • 它将尝试自动检测构建步骤:Ant 、NAnt 、Gradle 、Maven 、MSBuild 、Visual Studio 解决方案文件、PowerShell 、Xcode 项目文件、Rake ,以及 IntelliJ IDEA 项目。 您可以随时添加和编辑它们 手动

接下来,TeamCity 将显示建议图标,并提示创建 构建触发器失败条件构建功能。 根据构建配置设置,它可能会建议一些额外的配置选项。

在构建配置创建后,您可以运行构建和/或调整设置。

创建指向特定 VCS 的构建配置

构建配置创建向导 中:

  1. 点击与您的 VCS 相对应的按钮:来自 GitHub.com、GitLab CE / EE、Bitbucket Cloud、Azure DevOps Services 或 JetBrains Space。
    请注意,为了能够访问选定的 VCS,TeamCity 需要始终具有其可供使用的连接参数。 您可以提前配置连接预设并在向导中选择目标 VCS 服务器,或者让 TeamCity 直接从向导将您重定向到 Connections 页面。 受支持的 VCS 提供商的连接设置在 这里 描述。

  2. 验证与 VCS 的连接。

  3. TeamCity 将提出建立配置名称。 如有需要,您可以更改它。
    对于 Git 仓库,它还会自动检测默认分支。 您现在或稍后有选项在 VCS root 设置中进行更改。 您也可以更改分支规格:默认情况下,TeamCity会监视存储库的所有分支,但您可以通过输入 自定义规则来选择监视哪些特定分支。
    点击 Proceed(继续)。

  4. TeamCity 将添加一个 VCS 构建触发器,并尝试自动检测构建步骤:Ant、NAnt、Gradle、Maven、MSBuild、Visual Studio 解决方案文件、PowerShell、Xcode 项目文件、Rake 以及 IntelliJ IDEA 项目。 在 自动检测构建步骤 页面上,选择要在您的构建配置中使用的步骤。 点击 Use selected。 您可以随时添加或编辑步骤手动
    根据构建配置设置,TeamCity 可以提供一些额外的配置选项。 审查建议的设置 suggestedSettings.PNG 并配置所需的设置。

构建配置已创建。 点击 Run 来启动其首次构建。

手动创建构建配置

在构建配置创建向导中:

  1. 点击 Manually(手动)

  2. Create Build Configuration (创建构建配置)对话框中,指定构建配置的名称、ID 和(可选)描述,然后点击 Create(创建)。

  3. 继续创建其他设置:

    • 创建/编辑 VCS 根并指定 VCS 特定设置

    • 构建步骤 页面上,配置自动检测发现的构建步骤。 要手动创建它们,您可以从下拉菜单中选择所需的构建运行程序。 点击 Save。 您可以在一个构建配置中添加尽可能多的构建步骤。 请注意,它们将会按顺序执行。 最后,构建会获得合并状态,输出则会进入同一构建日志。 如果某个步骤失败,其余步骤是否执行,取决于他们的步骤执行策略

    • 另外,配置 构建触发选项依赖项属性和变量,以及 代理要求

创建构建配置模板

创建新的 构建配置模板 的过程与创建新配置类似:

  1. 前往 Administration | Projects (管理 | 项目)页面并打开所需的项目。
    或者,利用 Projects (项目)弹出菜单来打开项目并点击 Edit Project Settings(编辑项目设置)。
    Project Settings (项目设置)页面将会打开。

  2. Project Settings (项目设置)页面,点击 Create template (创建模版)部分下的 Build Configuration Templates(构建配置模版)。

  3. 继续配置 一般设置VCS 设置,以及 构建步骤

或者,您可以从现有的构建配置中创建一个构建配置模板:

  1. 打开现有的构建配置设置页面,在屏幕右上角点击 Actions(操作),然后选择 Extract Template (提取模板)选项。

  2. 指定所需的设置,然后点击 Create

从模板创建构建配置

您可以通过两种方式创建模板化的构建配置:从模板设置页面,或通过创建常规配置并选择应使用的模板。

选项 #1:

  1. 导航至 Administration | Project,并选择拥有模板的项目。

  2. 点击 Build configuration templates (构建配置模板)部分下的所需模板。

    选择所需的模板
  3. 点击 Actions | Create build configuration from this template...(操作 | 从此模板创建构建配置...)。

    从模板创建新配置
  4. 指定新配置所需的设置。 除了 Manually,请不要点击任何其他图块;否则,您将创建一个不使用所选模板的新配置。

选项 #2:

  1. 导航至 Administration | Project,并选择拥有模板的项目。

  2. 点击 Create build configuration(创建构建配置),位于 Build Configurations (构建配置)部分下方。

    创建一个常规配置
  3. 点击 Manually (手动)图块,然后在 Based on template (基于模板)下拉菜单中选择所需的模板。

    创建一个常规配置

选项#2在 Build configuration templates (构建配置模版)部分未显示所需模板时非常有用,因为该模板为其他(子)项目所拥有。

构建配置排序

您可以在 项目概览 页面查看项目的所有构建配置。 默认情况下,它们是按字母顺序列出的,但管理员可以 自定义这个顺序

构建配置设置

构建配置设置包括:

  • 一般设置

  • 版本控制设置,定义了如何从 VCS 中检索源代码,检出到何处等等

  • 构建步骤,即按顺序运行的动作:例如,运行 msbuild,一个脚本,或单位测试

  • 触发器,这些是定义何时启动新构建的规则

  • 失败条件 规定了何时会将构建标记为失败

  • 附加的 构建功能

  • 依赖项:

    • 对于 快照依赖,TeamCity 会在它们所依赖的构建开始时运行所有依赖的构建,这些源是在构建开始时获取的。

    • 对于 工件依赖,在构建开始之前,所有这个构建依赖的工件都将被下载并放置在它们配置的目标位置,然后将由构建使用。

  • 参数允许共享设置

  • 代理要求指定某个构建配置是否可以在特定的构建代理上运行。

配置设置

当您从构建配置列表中选择一个构建配置后,TeamCity 会显示 Build Configuration Home 页面,在此页面上您可以预览其最近的构建结果。 要访问构建配置的设置, 请在屏幕右上角点击 编辑配置设置

不同的构建配置设置在本节内的各篇文章中有所描述。

编辑构建配置的权限

虽然只有具有 项目管理员权限的用户才能更改项目和构建配置设置,但是对源代码做出贡献的参与者也有许多方式可以影响构建设置和环境。

默认的 Project Developer 角色 授予用户两项权限:

  • 自定义构建参数允许更改构建配置参数的值,从而可能影响源代码的执行方式。

  • 使用自定义补丁更改构建源代码允许根据用户的本地源文件运行自定义构建,而这些文件尚未提交至存储库。

此外,所有编写源代码或/和可以在其中存储项目设置的 Kotlin DSL 仓库中写入的用户,都可能在共享构建代理上执行他们的任意代码。

我们建议在授予用户上述权限或向项目仓库写入访问权限时,考虑这个方面。 如果需要,您可以调整分配给每个 权限的集合

在构建配置设置中的操作

使用位于设置屏幕右上角的 Actions 菜单,以:

最后修改日期: 16日 7月 2024年