创建和编辑项目
此部分详细介绍了通过 TeamCity 网页用户界面创建项目的步骤。 其他选项包括 REST API 和使用基于 Kotlin 语言 的 TeamCity 项目配置。
要创建项目,请使用右上角的 管理 链接并单击 创建项目。 显示 创建项目 页面。
有几种创建项目的选项:
请注意,默认仅提供两个选项: 从仓库 URL和 手动。 如果在根项目(或要创建的项目的父项目)中配置了到某个 VCS 托管服务的 连接 ,则相应的选项将变得可用,因此您可以使用现有的 VCS 连接规格创建项目。
tip
在您从URL或VCS创建项目之后,您可以编辑项目描述。 要在项目描述中添加链接,请使用 Markdown 格式:\[My Project \](https://www.example.com)。
要创建子项目,请转到父项目的 项目设置页面,并使用可用选项之一,类似于创建项目。
在 创建项目 页面上,单击“From a repository URL”磁贴。
指定 项目设置:
设置
描述
父项目
从下拉菜单中选择父项目。
存储库 URL
一个 VCS 仓库 URL。 TeamCity 可识别 Subversion 、 Git 和 Mercurial 的 URL。 部分支持 TFS 和 Perforce。
此字段旁边的图标表示 TeamCity 支持的 VCS 托管服务。 如果您点击活动(高亮)图标,您将能够选择一个现有的连接规格。 如果您单击一个未激活的图标,您将被重定向到 _Add Connection_ 表单。
根据 URL 格式,以下身份验证设置可能会有所不同。身份验证
TeamCity 会根据 URL 格式自动将此字段设置为“密码或访问令牌”或“SSH 密钥”。
用户名
如果 Authentication 设置为"Password / Access token",则可用。 指定访问存储库所需的用户名。 如果您想访问允许匿名访问的公共仓库,可以留空。
密码
如果 Authentication 设置为"Password / Access token",则可用。 指定访问存储库所需的密码或令牌。 如果您想访问允许匿名访问的公共仓库,可以留空。
SSH key
如果 身份验证 设置为“SSH key”时可用。 允许您上传新的私有 SSH 密钥或选择 以前上传的密钥。
SSH 密码短语
如果 身份验证 设置为“SSH key”时可用。 允许您为加密的 SSH 密钥指定密码短语。
单击 继续。 TeamCity 将为您配置其余的设置。
它将确定 VCS 仓库的类型,自动配置 VCS 仓库设置,并建议项目和构建配置名称。
对于 Git 仓库,TeamCity 将自动检测默认分支,但您可以选择更改它,并通过输入其他分支的 规格 来监视其他分支。项目,构建配置和 VCS 根将自动创建。
TeamCity 将添加一个 VCS 构建触发器。
TeamCity 将尝试自动检测构建步骤:Ant 、NAnt 、Gradle 、Maven 、 MSBuild 、Visual Studio 解决方案文件、PowerShell 、Xcode 项目文件、Rake ,以及 IntelliJ IDEA 项目。
在 自动检测的构建步骤 页面上,选择检测到的步骤以用于构建配置。 单击 使用已选择的。 如果找不到步骤,您将必须手动 配置构建步骤。
您的项目和构建配置已经配置好了。 单击 运行 按钮以开始构建。
根据构建配置设置,TeamCity 可能会建议一些额外的配置选项。 在设置列表的末尾查看建议,并配置所需的选项。
在 创建项目 页面上,单击“From GitHub”磁贴以从 现有连接 创建项目。
选择一个仓库。 TeamCity 将验证仓库连接。 如果连接已经验证,新的页面会打开。
TeamCity 将显示项目和构建配置名称。 如有需要,请修改名称并单击 继续。 TeamCity 将自动检测默认的 Git 分支,但您可以选择更改它,并通过输入其 规格 来添加其他需要监控的分支。
TeamCity 将添加一个 VCS 构建触发器,并尝试自动检测构建步骤:Ant、NAnt、Gradle、Maven、MSBuild、Visual Studio 解决方案文件、PowerShell、Xcode 项目文件、Rake 和 IntelliJ IDEA 项目。
在 自动检测的构建步骤 页面上,选择检测到的步骤以用于构建配置。 单击 使用已选择的。
如果未找到步骤,您将需要 手动配置构建步骤。您的项目和构建配置已经配置好了。 单击 运行 开始构建。 根据构建配置设置,TeamCity 可以提供一些额外的配置选项。 在设置列表的最后查看 Suggestions 并配置所需的项。
在 创建项目 页面上,单击相应的“From Bitbucket”磁贴,以从现有的 Bitbucket Cloud、Server 或 Data Center 连接创建项目。 参阅此帮助文章,了解如何设置新的连接: Bitbucket Cloud | Bitbucket Server 和 Data Center。
选择一个仓库。 TeamCity 将验证仓库连接。 如果连接已经验证,新的页面会打开。
TeamCity 将显示项目和构建配置名称。 如有需要,请修改名称并单击 继续。 对于 Git 仓库,TeamCity 会自动检测默认分支,但您有更改它的选项,并通过输入其他分支的 规格来添加要监控的其他分支。
TeamCity 将添加一个 VCS 构建触发器,并尝试自动检测构建步骤:Ant、NAnt、Gradle、Maven、MSBuild、Visual Studio 解决方案文件、PowerShell、Xcode 项目文件、Rake 和 IntelliJ IDEA 项目。
在 自动检测的构建步骤 页面上,选择检测到的步骤以用于构建配置。 单击 使用已选择的。
如果未找到步骤,您将需要 手动配置构建步骤。您的项目和构建配置已经配置好了。 单击 运行 开始构建。 根据构建配置设置,TeamCity 可以提供一些额外的配置选项。 在设置列表的最后查看 Suggestions 并配置所需的项。
在 创建项目 页面上,单击“From GitLab”磁贴以从 现有连接 创建项目。
选择一个仓库。 TeamCity 将验证仓库连接。 如果连接已经验证,新的页面会打开。
TeamCity 将显示项目和构建配置名称。 如有需要,请修改名称并单击 继续。 TeamCity 将自动检测默认的 Git 分支,但您可以选择更改它,并通过输入其 规格 来添加其他需要监控的分支。
TeamCity 将添加一个 VCS 构建触发器,并尝试自动检测构建步骤:Ant、NAnt、Gradle、Maven、MSBuild、Visual Studio 解决方案文件、PowerShell、Xcode 项目文件、Rake 和 IntelliJ IDEA 项目。
在 自动检测的构建步骤 页面上,选择检测到的步骤以用于构建配置。 单击 使用已选择的。
如果未找到步骤,您将需要 手动配置构建步骤。您的项目和构建配置已经配置好了。 单击 运行 开始构建。 根据构建配置设置,TeamCity 可以提供一些额外的配置选项。 在设置列表的最后查看 Suggestions 并配置所需的项。
在 创建项目 页面上,单击“From Azure DevOps”磁贴以从 现有连接 创建项目。 推荐的 Git 仓库方法是使用 基于 OAuth 2.0 协议的连接。 如果您需要连接到 TFVC 仓库,请使用已过时的 基于 PAT 的连接。
选择一个仓库。 TeamCity 将验证仓库连接。 如果连接已经验证,新的页面会打开。
TeamCity 将显示项目和构建配置名称。 如有需要,请修改名称并单击 继续。 对于 Git 仓库,TeamCity 会自动检测默认分支,但您有更改它的选项,并通过输入其他分支的 规格来添加要监控的其他分支。
TeamCity 将添加一个 VCS 构建触发器,并尝试自动检测构建步骤。
在 自动检测的构建步骤页面 页面上选择检测到的步骤以用于构建配置。 单击 使用已选择的。
如果未找到步骤,您将需要 手动配置构建步骤。您的项目和构建配置已经配置好了。 单击 运行 开始构建。 根据构建配置设置,TeamCity 可以提供一些额外的配置选项。 在设置列表的最后查看 Suggestions 并配置所需的项。
tip
如果您正在寻找如何将 JetBrains Space 实例与 TeamCity 集成的信息,请查看此 完整集成指南!
在从 JetBrains Space 创建项目之前,您需要配置一个 专用连接到您的 Space 实例。
在 创建项目 页面上,单击“From JetBrains Space”磁贴以从 现有连接 创建项目。 首次使用时,系统将提示您登录 Space 并授权 TeamCity 查看您的用户资料和项目。 为了能够做到这一点,TeamCity 将为您的 Space 实例创建一个服务令牌以进行身份验证。
选择一个仓库。 TeamCity 将验证仓库连接。 如果连接已经验证,新的页面会打开。
TeamCity 将会显示项目和构建配置的名称。 如有需要,请修改它们并单击 继续。 对于 Git 仓库,TeamCity 会自动检测默认分支,但您有更改它的选项,并通过输入其他分支的 规格来添加要监控的其他分支。
TeamCity 将添加一个 VCS 构建触发器,并尝试自动检测构建步骤。
在 自动检测的构建步骤页面 页面上选择检测到的步骤以用于构建配置。 单击 使用已选择的。
如果未找到步骤,您将需要 手动配置构建步骤。您的项目和构建配置已经配置好了。 单击 运行 开始构建。 根据构建配置设置,TeamCity 可以提供一些额外的配置选项。 在设置列表的最后查看 Suggestions 并配置所需的项。
单击 创建项目 按钮并选择 手动。
在 创建新项目 页面上,指定 项目设置:
设置 | 描述 |
---|---|
父项目 | 从下拉菜单中选择父项目。 |
名称 | 项目名称。 |
项目 ID | 项目的 ID |
描述 | 项目的可选描述。 您可以在描述中以 Markdown 格式添加链接:
|
单击 创建。 创建了一个空项目。
tip
要配置现有项目,请在列表中选择所需的项目并 打开其设置。
您可以在 项目 页面上查看所有可用的项目和子项目,默认按字母顺序列出。 管理员可以 自定义默认顺序。
当您从列表中选择一个项目时,TeamCity 会显示 项目主页 页面,您可以在其中预览其嵌套的构建配置和最近的构建结果。 要访问项目的设置,请单击右上角的相应切换按钮以切换到 编辑模式。
要复制、移动、删除或 存档项目,请使用 操作 菜单,该菜单位于 项目设置页面的右上角,或使用父 项目设置页面中项目旁边的 更多按钮 。 这些选项对 Root 项目来说并不可用。
使用 操作 菜单中的相应项,该菜单位于 项目设置页面的右上角,或使用父 项目设置页面中项目旁边的 更多按钮 。
项目可以由项目管理员复制并移动到另一个项目。
一个副本会复制原始项目的所有设置, 子项目, 构建配置和 模板 ,但是与构建相关的数据不会保留。 副本是在没有 构建历史 和没有 统计数据 的情况下创建的。
您可以将项目复制到相同或另一个父级中。
在复制时,TeamCity 会自动为副本分配一个新的名称和 ID。 也可以手动更改名称和 ID。
选择 复制与项目相关的用户、代理和其他设置 选项可确保所有设置(如通知规则或代理的兼容性)对于所有受影响的用户和代理与复制的项目和原始项目完全相同。
您也可以选择复制构建配置的构建编号。
note
当以 专业模式 运行 TeamCity 时,如果复制后服务器上的构建配置数量将超过限制(100 个构建配置,除非您购买了额外的构建代理许可证),则不会为项目显示 复制 选项。
warning
在移动项目之前,请考虑以下问题:
TeamCity 按 每个项目 分配用户角色,这意味着移动项目可能会导致新项目中的 更改用户权限的范围 (可能会添加新权限或删除现有权限)。
在项目移动后,包含 SSH 密钥的 Git VCS Roots 的连接可能会变得无法使用。
要移动项目,请使用 操作 菜单中的相应项,该菜单位于 项目设置页面的右上角,或使用父 项目设置页面中项目旁边的 更多按钮 。
使用 操作 菜单中的相应项,该菜单位于 项目设置页面的右上角,或使用父 项目设置页面中项目旁边的 更多按钮 。 请参阅专用的 页面。
warning
执行此操作时必须谨慎。 修改 ID 将会改变与项目相关的所有 URL。 强烈建议更新任何书签或脚本中硬编码的 URL 中的 ID。 在磁盘上的相应配置和工件目录名称也会发生改变,这可能需要一些时间。
您可以为项目的所有或选择的构建配置 暂停触发器。 使用 操作 菜单中的相应项,该菜单位于 项目设置页面的右上角,或使用父 项目设置页面中项目旁边的 更多按钮 。
您可以 导出配置文件以及项目的子文件,以便将其迁移到另一台 TeamCity 服务器。 使用 操作 菜单中的相应项,该菜单位于 项目设置页面的右上角,或使用父 项目设置页面中项目旁边的 更多按钮 。
使用 操作 菜单中的相应项,该菜单位于 项目设置页面的右上角,或使用父 项目设置页面中项目旁边的 更多按钮 。
当您删除一个项目时,TeamCity 将会移除其 .xml
配置文件。 删除后,项目将被移动到 \< TeamCity 数据目录 \>/config/_trash/.ProjectID.projectN 目录。 在所有与删除的项目相关的数据(构建历史、工件等)在下一次构建历史清理过程中完全删除之前,有一个 可配置 的超时期限(默认为5天)。
tip
您可以在运行清理程序之前 恢复已删除的项目。
\< TeamCity 数据目录 \>/config/_trash/ 目录不会自动清理,如果您确定不需要已删除的项目,可以手动清空。
tip
如果您试图删除带有来自其他项目的 依赖构建配置 的项目,TeamCity 将会对您发出警告。 如果您继续进行删除,那么依赖项将无法正常工作。