Sync from pcit-ce/pcit@f5680f9 by PCIT

Author: khs1994

.pcit.yaml

@@ -6,10 +6,10 @@ steps:
 
   upload-docs:
     image: pcit/pages
-    when:
+    if:
       status: success
       event: ['push']
-    settings:
+    with:
       keep_history: true
       # target_branch: gh-pages
       git_url: github.com/pcit-ce/docs
@@ -21,10 +21,10 @@ steps:
 
   upload-docs-to-gitee:
     image: pcit/pages
-    when:
+    if:
       status: success
       event: ['push']
-    settings:
+    with:
       keep_history: true
       # target_branch: gh-pages
       git_url: gitee.com/pcit-ce/docs

.vuepress/config.js

@@ -44,12 +44,12 @@ module.exports = {
         'language',
         'clone',
         'workspace',
-        'pipeline',
+        'steps',
         'services',
-        'matrix',
+        'jobs',
         'cache',
         'branches',
-        'notifications',
+        'image',
         'networks',
         'system',
         'platform',

SUMMARY.md

@@ -18,12 +18,12 @@
     * [language](usage/language.md)
     * [clone](usage/clone.md)
     * [workspace](usage/workspace.md)
-    * [pipeline](usage/pipeline.md)
+    * [steps](usage/steps.md)
     * [services](usage/services.md)
-    * [matrix](usage/matrix.md)
+    * [jobs](usage/jobs.md)
     * [cache](usage/cache.md)
     * [branches](usage/branches.md)
-    * [notifications](usage/notifications.md)
+    * [image](usage/image.md)
     * [networks](usage/networks.md)
     * [system](usage/system.md)  
     * [skip build](usage/skip.md)

api/system/README.md

@@ -4,40 +4,46 @@
 
 | Method | URL                     |
 | :----- | :-----------------------|
-| `GET`    | `/ci/oauth_client_id` |
+| `GET`  | `/ci/oauth_client_id`   |
 
 **Example:** `/ci/oauth_client_id`
 
 ## 获取系统待构建任务数
 
 | Method | URL                     |
 | :----- | :-----------------------|
-| `GET`    | `/ci/pending`         |
+| `GET`  | `/ci/pending`           |
 
 ## 获取 GitHub App 安装地址
 
 | Method | URL                                   |
 | :----- | :-----------------------              |
-| `GET`    | `/ci/github_app_installation/{uid}` |
+| `GET`  | `/ci/github_app_installation/{uid}`   |
 
 ## 获取 GitHub App 设置地址
 
 | Method | URL                                    |
 | :----- | :-----------------------               |
-| `GET`    | `/ci/github_app_settings/{org_name}` |
+| `GET`  | `/ci/github_app_settings/{org_name}`   |
 
 ## About
 
 > 获取 PCIT 描述文件（md 格式）
 
 | Method | URL |
 | :---   | :--- |
-| `GET` | `/ci/about` |
+| `GET`  | `/ci/about` |
 
 ## Changelog
 
 > 获取 PCIT `CHANGELOG` 描述文件（md 格式）
 
 | Method | URL |
 | :---   | :--- |
-| `GET` | `/ci/changelog` |
+| `GET`  | `/ci/changelog` |
+
+## 验证 `.pcit.yml`
+
+| Method | URL |
+| :---   | :--- |
+| `POST` | `/validate` |

usage/image.md

@@ -0,0 +1,10 @@
+# image
+
+`image` 指令用来设置 `steps` 的默认镜像。
+
+```yaml
+steps:
+  script: echo exec script
+
+image: khs1994/php:7.4.0-cli-alpine
+```

usage/matrix.md renamed to usage/jobs.md

@@ -1,29 +1,29 @@
-# matrix
+# jobs
 
-`matrix` 用来设置构建矩阵。常见的场景就是项目需要在不同的软件版本中进行测试。
+`jobs` 用来设置构建矩阵。常见的场景就是项目需要在不同的软件版本中进行测试。
 
 例如我们需要在 PHP 7.4 和 7.3 版本中进行测试。
 
 ```yaml
-pipeline:
+steps:
   php:
     image: khs1994/php-fpm:${PHP_TAG}
     ...
 
-matrix:
+jobs:
   PHP_TAG:
     - 7.4.3-alpine
     - 7.3.11-alpine    
 ```
 
 我们在 `image` 指令中设置变量 `${PHP_TAG}`
 
-在 `matrix` 中设置变量值
+在 `jobs` 中设置变量值
 
 以上构建相当于
 
 ```yaml
-pipeline:
+steps:
   php:
     image: khs1994/php-fpm:7.4.3-alpine
     ...
@@ -33,4 +33,4 @@ pipeline:
     ...
 ```
 
-很明显 `matrix` 指令的使用可以简化 `pipeline` 指令。同时很适用于项目需要在多个软件版本中进行测试、构建的场景。
+很明显 `jobs` 指令的使用可以简化 `steps` 指令。同时很适用于项目需要在多个软件版本中进行测试、构建的场景。

usage/language.md

@@ -1,6 +1,6 @@
 # language
 
-设置项目的语言，该指令影响 `pipeline` 的默认 `image` 等值。
+设置项目的语言，该指令影响 `steps` 的默认 `image` 等值。
 
 ```yaml
 language: php

usage/networks.md

@@ -5,7 +5,7 @@
 ## 自定义 hosts
 
 ```yaml
-pipeline:
+steps:
   ping:
     commands:
       - ping

usage/notifications.md

@@ -1,6 +1,6 @@
 # platform
 
-`platform` 指令只对 `steps/pipeline` 有效，对 `services` 无效。与 `docker run --platform` 参数的作用一致。
+`platform` 指令只对 `steps` 有效，对 `services` 无效。与 `docker run --platform` 参数的作用一致。
 
 ```yaml
 platform:

usage/platform.md

@@ -1,13 +1,13 @@
-# pipeline
+# steps
 
 ## 基本指令
 
-`pipeline` 指令用来设置具体的构建步骤，每个步骤均运行在容器中，所以每个步骤必须首先指定 Docker Image 名称 (`image`) 和具体的构建指令 (`commands`) 。
+`steps` 指令用来设置具体的构建步骤，每个步骤均运行在容器中，所以每个步骤必须首先指定 Docker Image 名称 (`image`) 和具体的构建指令 (`commands`) 。
 
-> pipeline 指令可以包含多个构建步骤
+> steps 指令可以包含多个构建步骤
 
 ```yaml
-pipeline:
+steps:
   php:
     image: khs1994/php-fpm:7.4.3-alpine
     commands:
@@ -29,12 +29,12 @@ pipeline:
 
 设置构建步骤所运行的命令。
 
-## 3. `environment` 环境变量
+## 3. `environment`
 
 除了以上两个基本指令外，还可以像我们平时使用 `$ docker container run -e "K=V" ...` 命令那样设置 **环境变量**。
 
 ```yaml
-pipeline:
+steps:
   php:
     image: khs1994/php-fpm:7.4.3-alpine
     environment:
@@ -44,12 +44,12 @@ pipeline:
       - vendor/bin/phpunit
 ```
 
-## 4. `pull` 镜像拉取策略
+## 4. `pull`
 
 每次构建时，无论 Docker Image 是否存在总是拉取镜像，可以使用 `pull: true` 指令(默认为 `false`)。
 
 ```yaml
-pipeline:
+steps:
   php:
     image: khs1994/php-fpm:7.4.3-alpine
     pull: true
@@ -63,35 +63,35 @@ pipeline:
 默认的 shell 为 `sh`，你可以改为 `bash`
 
 ```yaml
-pipeline:
+steps:
   php:
     image: khs1994/php-fpm:7.4.3-alpine
     shell: bash
 ```
 
 全部支持的 `shell` 包括 `sh` `bash` `python` `pwsh` `node`
 
-## 6. `when` 构建条件
+## 6. `if`
 
-可以通过 `when` 指令设置构建条件。
+可以通过 `if` 指令设置构建条件。
 
 ```yaml
-pipeline:
+steps:
   php:
     image: khs1994/php-fpm:7.4.3-alpine
     commands:
       - composer install -q
       - vendor/bin/phpunit
-    when:
+    if:
       event: tag
 ```
 
-增加以上的 `when` 指令之后，构建仅在 Git 打标签之后执行，当 push、pull_request 均不进行构建。
+增加以上的 `if` 指令之后，构建仅在 Git 打标签之后执行，当 push、pull_request 均不进行构建。
 
 全部可用的设置如下：
 
 ```yaml
-when:
+if:
   # platform: linux/amd64
   # platform:  [ linux/*, windows/amd64 ]
 
@@ -109,7 +109,7 @@ when:
   #   include: [ master, release/* ]
   #   exclude: [ release/1.0.0, release/1.1.* ]
 
-  # matrix:
+  # jobs:
   # - K: v
   #   K2: v2
   #   K3: v3
@@ -124,7 +124,7 @@ when:
 该指令用来配置插件。
 
 ```yaml
-pipeline:
+steps:
   settings:
     provider: docker
     k: v