这个指令允许我们为一个声明式流水线指定项目参数。这些参数的输入值可以来自一个用户或者一个API调用。
下面列举了所有合法的参数类型,以及他们的描述和示例:
booleanParam
这是基本的true/false参数。其子参数为name、defaultValue及description。
choice
此参数允许用户从一个选项列表中选择。其子参数为name、choices及description。这里的choices指的是你所输入的以换行符分隔的展示给用户的选项列表。列表中的第一个值会作为默认值。
file
此参数允许用户选择一个文件给流水线使用。其子参数包含fileLocation和description。
已选择的文件位置表明哪里可以用来存放我们选择并上传的文件。这个位置是相对于工作空间而言的相对路径。
text
此参数允许用户输入一个多行文本。其子参数包括name、defaultValue及description。
password
此参数允许用户输入一个密码。对于密码,输入的文本被隐藏了起来。可用的子参数包括name、defaultValue及description。
run
此参数允许用户从某个任务中选择一个特定的运行。此参数可能会被用在一个测试环境之中。可用的子参数包括name、project、description及filter。
这个project子参数就是你想让用户从其中选择运行的项目。默认的运行会是最近的一次。无论选择哪个项目,在脚本中你都可以通过一些环境变量访问它们。这些环境变量包括:
· PARAMETER_NAME=<jenkins_url>/job/<job_name>/<run_number>/
· PARAMETER_NAME_JOBNAME=<job_name>
· PARAMETER_NAME_NUMBER=<run_number>
· PARAMETER_NAME_NAME=<display_name>
· PARAMETER_NAME_RESULT=<run_result>
这个filter子参数允许你基于整体的构建状态筛选某类型的运行。可以选择:
· All Builds——包括运行中的构建
· Completed Builds
· Successful Builds——包括稳定和不稳定的构建
· Stable Builds Only
string
此参数允许用户输入一个字符串。(它并不会像password参数那样被隐藏起来)。其子参数包括description、defaultValue及name。
在流水线中使用参数
一旦你在parameters代码块中定义了一个参数,你就可以在你的流水线中通过params命名空间按照params.<parameter_name>的格式引用这个参数。下面是一个简单的示例,在声明式流水线中使用了一个string参数: