你可以使用环境变量扩展为你的流水线步骤提供自定义环境变量。此外，这个扩展还可以用于将默认密钥或默认插件参数注入到你的流水线中（密钥和插件参数会作为环境变量传递给你的流水线）。

扩展配置

你可以通过提供以下配置参数在你的 Runner 上注册一个扩展：

DRONE_ENV_PLUGIN_ENDPOINT

提供用于向扩展发起 HTTP 请求的端点（endpoint）。
DRONE_ENV_PLUGIN_TOKEN

提供用于验证对扩展的 http 请求的令牌。这个令牌在服务器和扩展之间共享。

扩展工作原理

Runner 会发起 HTTP POST 请求以获取一组环境变量，这些变量会注入到每个流水线步骤中。

扩展请求响应

环境变量扩展会收到一个 HTTP 请求，以返回一组环境变量。请求正文以 JSON 编码，包括仓库和构建信息。

以下是请求体的定义：

1
2
3
4


class Request {
    repo: Repository;
    build: Build;
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28


class Repository {
    id: int64;
    uid: int64;
    user_id: int64;
    namespace: string;
    name: string;
    slug: string;
    scm: string;
    git_http_url: string;
    git_ssh_url: string;
    link: string;
    default_branch: string;
    private: boolean;
    visibility: string;
    active: boolean;
    config: string;
    trusted: boolean;
    protected: boolean;
    ignore_forks: boolean;
    ignore_pulls: boolean;
    cancel_pulls: boolean;
    timeout: int64;
    counter: int64;
    synced: int64;
    created: int64;
    updated: int64;
    version: int64;
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34


class Build {
    id: int64;
    repo_id: int64;
    number: int64;
    parent: int64;
    status: string;
    error: string
    event: string;
    action: string;
    link: string;
    timestamp: int64;
    title: string;
    message: string;
    before: string;
    after: string;
    ref: string;
    source_repo: string;
    source: string;
    target: string;
    author_login: string;
    author_name: string;
    author_email: string;
    author_avatar: string;
    sender: string;
    params: [string][string];
    cron: string;
    deploy_to: string;
    deploy_id: int64;
    started: int64;
    finished: int64;
    created: int64;
    updated: int64;
    version: int64;
}

扩展请求响应

环境变量扩展应该以 HTTP 200 响应代码响应请求，并以 JSON 格式返回一组环境变量的列表。

以下是响应体的示例：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


[
  {
    "name": "keya",
    "data": "valuea",
    "mask": false
  },
  {
    "name": "keyb",
    "data": "valueb",
    "mask": false
  }
]

扩展请求鉴权

HTTP 请求根据 HTTP 签名规范草案使用共享 Secret 进行签名。请求接收者应该使用签名来验证 WebHook 的真实性和完整性。

起始项目 (模板)

如果你有兴趣创建一个 Environment 扩展，我们建议使用我们的起始项目模板作为基础来启动开发。