BatchScript@1 - Batch 腳本 v1 工作

  • 發行項

使用此工作來執行 Windows .bat 或 .cmd 腳本。 或者， .bat 或 .cmd 腳本可以永久修改環境變數。

Syntax

# Batch script v1
# Run a Windows command or batch script and optionally allow it to change the environment.
- task: BatchScript@1
  inputs:
    filename: # string. Required. Path. 
    #arguments: # string. Arguments. 
    #modifyEnvironment: False # boolean. Modify Environment. Default: False.
  # Advanced
    #workingFolder: # string. Working folder. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

# Batch Script v1
# Run a windows cmd or bat script and optionally allow it to change the environment.
- task: BatchScript@1
  inputs:
    filename: # string. Required. Path. 
    #arguments: # string. Arguments. 
    #modifyEnvironment: False # boolean. Modify Environment. Default: False.
  # Advanced
    #workingFolder: # string. Working folder. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

輸入

filename - 路徑
string. 必要。

要執行的 或 .bat 腳本路徑 .cmd 。 這應該是與預設工作目錄相對的完整路徑或路徑。 (請注意，工作目錄可能與 不同 workingFolder ，此目錄可能會為此工作指定。)


arguments - 參數
string.

傳遞至 或 .bat 腳本的 .cmd 引數。


modifyEnvironment - 修改環境
boolean. 預設值：False。

判斷環境變數修改是否會影響後續工作。


workingFolder - 工作資料夾
string.

執行腳本時目前的工作目錄。 這會預設為腳本所在的資料夾。


failOnStandardError - 標準錯誤失敗
boolean. 預設值：false。

如果這是 true，如果有任何錯誤寫入 StandardError 資料流程，此工作將會失敗。


工作控制選項

除了工作輸入之外，所有工作都有控制選項。 如需詳細資訊，請參閱 控制項選項和一般工作屬性。

輸出變數

無。

備註

使用此工作來執行 Windows .bat 或 .cmd 腳本。 或者，允許它永久修改環境變數。

注意

這項工作與 Windows 容器不相容。 如果您需要在 Windows 容器上執行批次腳本，請改用 命令列工作 。

如需支援多個平臺的資訊，請參閱 跨平臺腳本。

範例

在存放庫的根目錄建立 test.bat ：

@echo off
echo Hello World from %AGENT_NAME%.
echo My ID is %AGENT_ID%.
echo AGENT_WORKFOLDER contents:
@dir %AGENT_WORKFOLDER%
echo AGENT_BUILDDIRECTORY contents:
@dir %AGENT_BUILDDIRECTORY%
echo BUILD_SOURCESDIRECTORY contents:
@dir %BUILD_SOURCESDIRECTORY%
echo Over and out.

若要執行此腳本，請將下列工作新增至您的管線。

- task: BatchScript@1
  inputs:
    filename: 'test.bat'

規格需求

需求 描述
管線類型 YAML、傳統組建、傳統版本
執行于 Agent、DeploymentGroup
要求 自我裝載代理程式必須具備符合下列需求的功能，才能執行使用此工作的作業：Cmd
Capabilities 此工作不符合作業中後續工作的任何需求。
命令限制 任意
Settable 變數 任意
代理程式版本 1.83.0 或更新版本
工作類別 公用程式