Jenkins的环境变量使用说明

缺乏、安全感 2023-10-06 08:28 14阅读 0赞

### 一、使用方法 ###

下面的环境变量可以在配置Jenkins Job的时候用得到，可以用在Execute shell、Execute Windows batch command、文本框 上加上编辑好的的shell脚本。  
1.**Windows**：`%BUILD_NUMBER%`，即 `%变量名%`的形式。

2.**Linux**：`${BUILD_NUMBER}` ，也可以直接使用`$BUILD_NUMBER`。  
倘若是自己定义的参数化（Parameter）在调用时可以直接 用 $参数名，即直接使用 $endPoint的形式来完成对环境变量的调用。

3.**在Maven或者Ant中使用**：  
**Maven**：直接使用：`${env.WORKSPACE}`

**Ant**：需要增加`<property environment="env"/>`节点，再使用`${env.WORKSPACE}`。

### 二、可用的环境变量 ###

**BRANCH\_NAME**  
对于多分支项目，这将被设置为正在构建的分支的名称，例如，如果您希望从master部署到生产环境而不是从feature分支部署；如果对应某种更改请求，则该名称通常是任意的（请参阅下面的CHANGE\_ID和CHANGE\_TARGET）；  
**CHANGE\_ID**  
对于与某种更改请求相对应的多分支项目，这将被设置为更改ID，例如拉取请求编号（如果支持）;其他未设置；  
**CHANGE\_URL**  
对于与某种更改请求相对应的多分支项目，这将被设置为更改URL(如果支持)；其他未设置；  
**CHANGE\_TITLE**  
对于与某种更改请求相对应的多分支项目，这将被设置为更改的标题（如果支持）;其他未设置；  
**CHANGE\_AUTHOR**  
对于与某种更改请求相对应的多分支项目，这将被设置为建议更改的作者的用户名（如果支持）;其他未设置；  
**CHANGE\_AUTHOR\_DISPLAY\_NAME**  
对于与某种更改请求相对应的多分支项目，这将被设置为建议更改的作者的人名（如果支持）;其他未设置；  
**CHANGE\_AUTHOR\_EMAIL**  
对于与某种更改请求相对应的多分支项目，这将被设置为建议更改的作者的Email地址（如果支持）;其他未设置；  
**CHANGE\_TARGET**  
对于与某种更改请求相对应的多分支项目，这将被设置为合并到的目标或者基础分支（如果支持）;其他未设置；  
**BUILD\_NUMBER**  
当前构建的编号，例如“4674”等  
**BUILD\_ID**  
当前构建的版本ID，与构建的BUILD\_NUMBER相同  
**BUILD\_TAG**  
“jenkins - $ \{JOB\_NAME\} - $ \{BUILD\_NUMBER\}”的字符串。 JOB\_NAME中的所有正斜杠（/）都用破折号（ - ）替换。方便地放入资源文件，jar文件等，以便于识别。  
**BUILD\_DISPLAY\_NAME**  
当前版本的显示名称，默认为“\# 4674”，即BUILD\_NUMBER。  
**JOB\_NAME**  
即此版本的项目名称，例如“foo”或“foo / bar”。  
**JOB\_BASE\_NAME**  
此构建的项目的短名称剥离文件夹路径，例如“bar / foo”的“foo”。  
**EXECUTOR\_NUMBER**  
唯一编号，用于标识执行此构建的当前执行程序（在同一台计算机的执行程序中）。这是您在“构建执行程序状态”中看到的数字，但数字从0开始，而不是从1开始。  
**NODE\_NAME**  
如果构建在代理上，则代理的名称; 如果在主版本上运行，则为“MASTER”；  
**NODE\_LABELS**  
节点分配的空白分隔的标签列表。  
**WORKSPACE**  
作为工作空间分配给构建的目录的绝对路径。  
**JENKINS\_HOME**  
Jenkins用于存储数据的主节点上分配的目录的绝对路径。  
**JENKINS\_URL**  
Jenkins的完整URL，如http：// server：port / jenkins /（注意：仅在系统配置中设置Jenkins URL时可用）  
**BUILD\_URL**  
此版本的完整URL，例如http：// server：port / jenkins / job / foo / 15 /（必须设置Jenkins URL）  
**JOB\_URL**  
该作业的完整URL，例如http：// server：port / jenkins / job / foo /（必须设置Jenkins URL）  
**GIT\_COMMIT**  
The commit hash being checked out.  
**GIT\_PREVIOUS\_COMMIT**  
The hash of the commit last built on this branch, if any.  
**GIT\_PREVIOUS\_SUCCESSFUL\_COMMIT**  
The hash of the commit last successfully built on this branch, if any.  
**GIT\_BRANCH**  
远程分支名称，如果有的话。  
**GIT\_LOCAL\_BRANCH**  
本地分支名称，如果有的话。  
**GIT\_URL**  
远程git仓库的URL。如果有多个，将会是GIT\_URL\_1，GIT\_URL\_2等。  
**GIT\_COMMITTER\_NAME**  
配置的Git提交者名称（如果有的话）。  
**GIT\_AUTHOR\_NAME**  
配置的Git作者姓名（如果有的话）。  
**GIT\_COMMITTER\_EMAIL**  
配置的Git提交者电子邮件（如果有的话）。  
**GIT\_AUTHOR\_EMAIL**  
已配置的Git作者电子邮件（如果有）。  
**SVN\_REVISION**  
当前工作区的Subversion版本号，例如“12345”。  
**SVN\_URL**  
当前工作区的Subversion版本号，例如“12345”。