---
url: /zh/build/quick-start.md
description: |
  云原生构建快速入门指南，手把手引导用户创建并运行第一条流水线， 以及编写用于代码质量守护的 PR 流水线。
---
`云原生构建`提供开箱即用的 CI/CD 能力，核心在于**声明式配置**：在特定**分支**发生特定**事件**时，
自动执行一系列**任务**。

本文引导完成两个任务：

1. **用 NPC 添加并运行第一条流水线**：无需手写配置，让 CodeBuddy 帮你快速跑通
2. **编写实用的 PR 流水线**：学习配置用于代码质量守护的常见流水线

***

## 第一部分：用 CodeBuddy 快速添加第一条流水线

CodeBuddy 是与平台深度融合的 NPC（自动化角色），熟悉 `.cnb.yml` 流水线语法。
无需手动编写配置、在 WebIDE 里逐个点选，只需在评论里告诉它需求，
就能快速跑通第一条流水线。

### 第一步：准备仓库

如果你还没有代码仓库，先在组织下创建一个**空仓库**，作为流水线运行的载体。

### 第二步：@CodeBuddy 添加流水线

在仓库里新建一个 Issue（或在 PR 中），\*\*勾选「替我上班」\*\*后 `@CodeBuddy` 并描述需求：

```text
@CodeBuddy 帮我在 main 分支配置一条流水线：当代码 push 时输出 "hello world"
```

NPC 会代替你完成剩下的一切：

1. 在仓库根目录生成 `.cnb.yml`——声明「代码推送到 `main` 分支时，自动运行输出
   `hello world` 的任务」
2. 提交并推送配置，触发流水线
3. 把执行结果汇报到当前评论

### 第三步：查看流水线执行结果

构建开始后，回到仓库主页，点击 `云原生构建` 标签页查看所有构建记录，点开最新一条
（由 `push` 事件触发）即可查看详细日志与状态。

恭喜！已通过 NPC 快速完成了第一次 CI/CD 实践，全程无需手写任何配置。

:::: tip 说明
上面生成的 `.cnb.yml` 等价于手动编写的配置，其完整语法会在第二部分继续展开讲解。
::::

## 第二部分：编写一个实用的 PR 检测流水线

接下来实现更实际的场景：**为 `main` 分支配置 Pull Request 流水线，
自动执行代码检查 (lint) 和测试 (test)，并在失败时通知团队。**

### 1. 定义分支和事件

指定规则生效的分支 (`main`) 和事件 (`pull_request`)，并在 `stages` 中按序执行代码检查 (lint) 和测试 (test)。

### 2. 定义失败处理

若 `stages` 中**任一任务失败**，可通过 `failStages` 自动执行告警任务。
以下是一个完整的 PR 检测流水线：

```yaml title=".cnb.yml"
main:
  pull_request:
    - name: pr-check
      stages:
        - name: lint
          script: echo "Running linting tools..."
        - name: test
          script: echo "Running test suites..."
      failStages:
        - name: notify-team
          script: echo "Notifying the chat group that the PR check failed!"
```

**流水线执行逻辑：**

1. 监听 `main` 分支的 `pull_request` 事件。
2. 启动 `pr-check` 流水线。
3. 按序执行 `stages` 中的任务（lint → test）。
4. 若所有任务成功，流水线状态为通过。
5. 若任一任务失败，立即中止并转而执行 `failStages` 中的任务。

## 下一步

* 🔧 **深入了解配置**：查看[配置文件详解](./configuration.md)，探索更多高级功能。
* 📖 **掌握完整语法**：前往[语法手册](./grammar.md)了解所有配置项。
* 🚀 **参考真实案例**：需要更多灵感？访问[最佳实践](https://cnb.cool/examples/showcase)，
  Fork 示例仓库或复用其配置，快速定制流水线。