C# 脚本

C# Script 运行器允许在 Windows 、 Linux 或 macOS 上执行 C# 脚本。它使用定制的 TeamCity 工具在各个平台上运行 C# Interactive shell。

使用此运行器，您可以执行各种服务任务，如准备构建环境，创建 OS 用户，或向不同的消息传递器进行报告。

参考配置构建步骤以获取常见构建步骤设置的描述。参考容器包装器了解如何在容器内运行这一步骤。

前提条件

运行器的要求：

.NET 运行时 6.0.0 或更高版本必须安装在构建代理上，或者如果此步骤在 Docker 内部运行，则必须在 Docker 容器中可用。
TeamCity.csi软件包必须作为代理工具进行安装。

C# 脚本设置

设置	描述
TeamCity C# 脚本工具	从通过管理 \| 工具安装的 TeamCity C# 脚本工具中选择一个版本，或者相对于构建检出目录输入此工具的自定义路径。
脚本类型	选择以下两个选项之一：直接在运行器中输入自定义脚本体，或指定 C# 脚本文件的路径（ `.csx`）。如果提交的脚本引用了另一个脚本，请确保引用的脚本的路径是相对于构建检出目录指定的。
C# 脚本	适用于 Custom Script* 类型。* 输入一个 C# 脚本的代码。
C# 脚本文件	适用于 Script File* 类型。* 输入到脚本文件的路径，相对于构建检出目录。
脚本形参	输入脚本的参数。参数作为 `实参` 数组传递。查看支持的参数。参数引用得到了支持。传递安全值出于安全原因，我们强烈建议您避免在脚本内直接使用参数引用，如果这些参数代表安全值。您可以通过脚本参数来传递此类值。例如，要传递令牌值，请使用“密码”类型添加一个新的构建参数，然后在运行器的脚本参数字段中引用它： `% \access_token %` 并将其作为脚本内的参数调用： `val accessToken = args[0]` 这样，您可以在脚本的任何地方重用令牌的值。这种做法将确保这些值仅在构建期间在代理上可用。否则，如果参数直接在脚本内指定，那么它们的解析值将会在代理机器上存储，只要脚本本身被存储，这可能会威胁到您的数据安全。
NuGet 包源	如果您在脚本中引用一个包，TeamCity 将会自动从此字段指定的源下载它。运行器可以自动解析像 `#r "nuget:System.Text.Json"` 和 `#r "nuget:System.Text.Json,4.7.2"` 这样的命令。默认情况下，TeamCity 会从 NuGet.org 上发布的源还原 NuGet 包。在此字段中，您可以指定通往其他 NuGet 存储库的路径，TeamCity 将按声明顺序在这些位置搜索包。如果在指定的存储库中找不到包源，TeamCity 将在 NuGet.org 上进行搜索。为了能够访问私有仓库，请配置 NuGet feed credentials。您也可以参考一下 TeamCity 内部源。

脚本中支持的命令和参数

支持的命令：

命令	描述	示例
`#r`	添加对 NuGet 包或程序集及其依赖项的引用。	`#r "nuget:<package_name>, 1.2.3"` 或 `#r "<library_name>.dll"`
`#加载`	加载指定的脚本文件并执行它。	`#load "<脚本名称>.csx"`
`#帮助`	显示可用命令和按键绑定的帮助。
`#l`	将详细程度设置为 `静默`、 `普通` 或 `跟踪`。

支持的参数：

在 脚本参数 字段中提供的参数并存储在 实参 数组中（例如， WriteLine(Args[0]) 用于写入第一个脚本参数的值）；
系统参数在Build Configuration Settings | Parameters中指定，并存储在 Props 字典中（例如， WriteLine(Props["version"]) 用来写入 system.version 参数的值）。

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