TeamCity On-Premises 2024.03 Help

SSH 上传

SSH 上传 构建运行程序允许通过 SSH(使用 SCP 或 SFTP 协议)上传文件/目录。

所有运行器的通用设置在 配置构建步骤 中有所描述;此页面详细介绍了 SSH Deployer 的设置。

以下字段支持 参数引用:任何在百分号之间的文本( % )都被 TeamCity 视为对属性的引用。 为了防止 TeamCity 将百分号内的文本视为属性的引用,使用两个百分号来转义它们:例如,如果您想要将 % \Y % \m % \d % \H % \M % \S 传递到构建中,请将其改为 %\%Y%\%m%\%d%\%H%\%M%\%S

选项

描述

步骤名称

Optional 在 TeamCity 用户界面中显示的构建步骤的名称。

步骤 ID

此构建步骤的 ID,必须在此配置的所有步骤中唯一。 用于URLs、REST API、DSL、向服务器的HTTP请求,以及TeamCity数据目录中的配置设置。

执行步骤

使您能够修改默认的构建条件,并可选择性地添加更多的 构建条件

部署目标

目标

SSH 服务器位置,文件将以此格式上传至此位置:

{hostname|IP_address}[:targer_dir[/sub_path]]

在这里, target_dir 可以是绝对的或相对的,而 sub_path 可以有任何深度。

传输协议

请选择一个协议来通过 SSH 传输数据。 可用选项包括:SCP 和 SFTP

端口

可选 端口。 默认端口为22。

超时

Optional 的连接超时时间(以秒为单位)。 默认为 0。

部署凭据

认证方法

选择一种身份验证方法:

  • 上传的密钥 — 使用上传到项目中的密钥。 参见 SSH 密钥管理 了解详细信息。

  • 默认私钥 — 使用 ~/.ssh/config 设置进行私钥认证,如果不存在设置文件,则使用 ~/.ssh/id_rsa 私钥文件。

  • 自定义私钥 — 使用指定的私钥文件和密码进行私钥认证。

  • Password — 使用简单密码验证。

  • SSH-Agent — 使用 SSH 代理进行身份验证,其中必须启用 SSH-Agent 构建功能

部署源

源代码的路径

将部署源指定为文件 / 目录路径的换行符或逗号分隔列表。

该字段支持 Ant 风格的通配符模式(例如, dir/**/*.zip
)。您也可以使用 文件 => 目录 模式指定要创建的目标目录(例如, *.zip => winFiles,unix/distro.tgz => linuxFiles 将创建 winFileslinuxFiles 目录,并分别把声明的文件放入其中)。

示例

例如,考虑您需要添加一个 SSH 上传构建步骤以将 Java 包上传到 SSH 服务器(位于 ssh.example.com 主机上)的情况。 假设您在 SSH 服务器上使用 jdoe 帐户,其主目录为 /jdoe ,并且 SSH 服务器已配置为使用 SSH 密钥进行身份验证。

  1. 按照 Generated SSH Keys 中的步骤在您的项目中生成一对新的 SSH 密钥。 调用密钥对 PackageUploadKey

  2. PackageUploadKey 密钥对中复制公钥。

  3. 登录到您的 SSH 服务器上的 jdoe 帐户,并按照您的 SSH 服务器提供商的指导将 PackageUploadKey 公钥添加到此帐户。

  4. 在您的项目构建配置中,转到 Build Steps 页面并点击 Add build step

  5. 新建构建步骤 页面上,选择 SSH 上传 运行程序。

  6. 新建构建步骤:SSH 上传 页面上,按照以下方式填写字段:

    • 步骤名称 — 输入 UploadJavaPackages

    • 目标 — 请输入 ssh.example.com:/jdoe

    • 认证方法 — 选择 已上传的密钥

    • 用户名 — 请输入 jdoe (SSH 服务器帐户的用户名)

    • 选择键 — 从下拉列表中选择 PackageUploadKey

    • 路径到源 — 请输入以下路径:

      ch-simple/simple/target/*.jar => packages

  7. 点击 Save 来创建构建步骤。

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