你可以使用 Validation 扩展来对.drone.yml配置文件执行自定义检查、验证和提示规则。

扩展配置

你可以通过向 Drone Server 提供以下配置参数来注册一个 validation 扩展：

DRONE_VALIDATE_PLUGIN_ENDPOINT

提供用于向一个扩展发出 http 请求的端点。
DRONE_VALIDATE_PLUGIN_SECRET

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

扩展工作原理

Drone Server 在处理 YAML 文件和调度任何流水线之前向验证扩展发起 HTTP POST 请求。验证扩展应该接受或拒绝 YAML 文件。

扩展请求响应

Validation 验证扩展收到一个 HTTP 请求，以验证 YAML 文件。请求正文以 JSON 格式包含存储库和构建的详细信息，以及原始的 YAML 配置文件。

以下是请求体的定义：

1
2
3
4
5


class Request {
  config: Config;
  repo: Repo;
  build: Build
}

1
2
3


class Config {
    data: string;
}

 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;
}

扩展请求响应

Validation 扩展应该以以下一种方式之一进行响应：

返回 200 响应代码，表示 YAML 文件通过了验证。
返回 400 响应代码，表示 YAML 文件未通过验证，同时返回 JSON 编码的错误信息，说明验证失败的原因。
返回 498 响应代码，表示 YAML 文件未通过验证，并应该被跳过。
返回 499 响应代码，表示 YAML 文件未通过验证，并应该被阻止，等待手动批准。

1
2
3


{
    "message": "cannot use image from external registry"
}

扩展请求鉴权

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

起始项目 (模板)

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