源的目录结构

为使项目成员更容易地理解和维护“源”，建议您将自定义任务、阶段和模板等定义文件按一定结构组织到逻辑目录中。例如，可将任务、阶段和模板拆分成不同模块，从而降低管理难度；还可借助清晰的命名约定提升文件可读性和一致性，以减少失误和混淆。

推荐的目录结构

1. 第一层是资源类型，比如 task 、stage 、pipeline 等。

2. 第二层是资源名称。建议与具体的任务、阶段或模板同名。

3. 第三层是资源版本。在遇到不兼容更新时，需要新增版本。

4. 第四层是具体的定义及说明文档。

   • 如果有资源的使用示例，可以放到 samples 目录下。

   • 如果有资源的的测试用例，可以放到 test 目录下。

目录结构示例

.
├── pipeline                         - 流水线模板类型
│   └── buildpacks                  - 某个模板
│       └── 0.1
│           └── buildpacks.yaml     - 模板的定义文件
└── task                             - 任务类型
    ├── argocd                       - 某个任务
    │   ├── 0.1
    │   │   ├── OWNERS
    │   │   ├── README.md
    │   │   ├── argocd.yaml         - 任务的定义文件
    │   │   └── samples
    │   │       └── deploy-to-k8s.yaml
    │   └── 0.2
    └── golang-build
        ├── 0.1
        │   ├── README.md
        │   ├── golang-build.yaml
        │   └── samples
        │       └── golang-build.yaml
        ├── OWNERS
        └── README.md