Tekton Catalog 贡献指南：如何提交你的第一个共享任务

【免费下载链接】catalogCatalog of shared Tasks and Pipelines.项目地址: https://gitcode.com/gh_mirrors/catalog3/catalog

欢迎参与 Tekton Catalog 开源项目贡献！本文将带你了解如何提交第一个共享任务（Task），为云原生 CI/CD 生态系统添砖加瓦。无论你是 DevOps 新手还是经验丰富的开发者，这份详细指南都能帮助你顺利完成贡献流程。

Tekton Catalog 是什么？

Tekton Catalog 是一个共享任务和流水线（Pipeline）的集合，旨在为 Kubernetes 环境提供可复用的 CI/CD 组件。通过贡献任务，你可以帮助全球开发者简化云原生应用的构建、测试和部署流程。

图 1：Tekton 资源关系示意图，展示了 Task、Pipeline、PipelineRun 等核心组件的关联方式

贡献前的准备工作

环境要求

• 安装 Git 和 Kubernetes 命令行工具（kubectl）
• 配置 Kubernetes 集群（推荐使用 Kind 或 Minikube）
• 了解 YAML 语法和 Tekton 基本概念

仓库克隆

首先克隆项目仓库到本地：

git clone https://gitcode.com/gh_mirrors/catalog3/catalog cd catalog

贡献流程详解

1. 选择贡献类型

Tekton Catalog 接受以下类型的贡献：

• 新任务（Task）：如代码检查、镜像构建、部署等功能模块
• 任务新版本：为现有任务提供功能更新或 bug 修复
• 流水线（Pipeline）：组合多个任务形成完整工作流

2. 创建新任务的步骤

步骤 1：创建任务目录

在task/目录下创建以任务名称命名的文件夹，并添加版本子目录：

mkdir -p task/your-task-name/0.1

步骤 2：编写任务定义

在版本目录中创建任务 YAML 文件（如your-task-name.yaml），需包含以下核心部分：

• 元数据：name、namespace、labels
• 规范（spec）：inputs（参数和资源）、steps（执行步骤）、outputs
• 描述：使用 annotations 添加文档说明

示例结构：

apiVersion: tekton.dev/v1beta1 kind: Task metadata: name: your-task-name annotations: description: "A brief description of your task" spec: params: - name: param1 type: string default: "default-value" steps: - name: step-1 image: your-image:tag command: ["command"] args: ["$(params.param1)"]

步骤 3：添加测试用例

为确保任务可靠性，需在tests/目录中提供测试用例：

mkdir task/your-task-name/0.1/tests

测试用例应包含：

• TaskRun/PipelineRun 定义（YAML 文件）
• 可选的前置/后置脚本（如pre-apply-task-hook.sh）

步骤 4：编写文档

创建README.md文件，包含：

• 任务功能描述
• 参数说明
• 使用示例
• 注意事项

步骤 5：指定维护者

创建OWNERS文件，列出任务维护者的 GitHub 用户名：

reviewers: - your-github-username approvers: - your-github-username

3. 提交新版本任务

如果需要为现有任务创建新版本，可按以下步骤操作：

# 复制现有版本 cp -a task/existing-task/0.1 task/existing-task/0.2 # 提交复制操作 git add task/existing-task/0.2 git commit -m "Copy task existing-task from 0.1 to 0.2" # 修改新版本内容并提交 git add task/existing-task/0.2 git commit -m "Update existing-task to 0.2: add new feature"

4. 本地测试任务

使用项目提供的测试脚本验证任务功能：

./test/run-test.sh task your-task-name 0.1

该脚本会在当前 Kubernetes 集群中创建临时命名空间，执行任务并输出结果。

技术规范与最佳实践

任务编写要求

• 可验证性：确保kubectl create -f task.yaml能成功执行
• 镜像要求：使用公共镜像仓库（gcr.io、docker.io 等），确保无严重安全漏洞
• 参数设计：提供合理默认值，必填参数需明确标记
• 文档完整性：包含用途、参数说明和使用示例

测试规范

• 提供至少一个功能测试用例
• 涉及外部服务时，使用模拟服务或测试替身
• 测试脚本应能独立运行，不依赖外部资源

图 2：Java 应用构建流水线示例，展示了多任务协作流程

提交 Pull Request

PR 准备

• 确保代码符合项目编码规范
• 提交前运行本地测试
• 保持提交历史清晰，每个提交专注单一功能

PR 提交步骤

1. Fork 项目仓库
2. 创建特性分支：git checkout -b feature/your-task-name
3. 提交更改：git commit -m "Add your-task-name task v0.1"
4. 推送到远程：git push origin feature/your-task-name
5. 在 GitCode 界面创建 Pull Request

PR 审核标准

维护者将从以下方面审核你的贡献：

• 功能实用性：任务是否解决实际问题
• 代码质量：YAML 格式正确，遵循最佳实践
• 测试覆盖：是否包含有效测试用例
• 文档完整性：README 是否清晰易懂

维护与协作

成为任务维护者

• 提交高质量任务后可申请成为维护者
• 在任务目录添加OWNERS文件指定维护者
• 维护者负责审核相关 PR 和解决 issue

社区协作

• 通过项目 issue 讨论功能需求
• 参与定期社区会议（详情见 社区文档）
• 关注 DEVELOPMENT.md 获取开发指南更新

常见问题解答

Q: 如何处理任务依赖？
A: 使用Task的params和resources定义依赖，复杂依赖可考虑创建 Pipeline。

Q: 任务镜像如何更新？
A: 提交新版本任务时更新镜像标签，确保向后兼容。

Q: 测试失败如何排查？
A: 使用kubectl logs查看任务执行日志，或本地运行./test/run-test.sh调试。

总结

贡献 Tekton Catalog 不仅能提升你的云原生开发技能，还能帮助全球开发者构建更高效的 CI/CD 流程。遵循本文指南，你已经掌握了提交共享任务的完整流程。现在就动手创建你的第一个任务，加入 Tekton 开源社区吧！

贡献资源：

• 官方贡献指南：CONTRIBUTING.md
• 任务推荐规范：recommendations.md
• 测试脚本：test/run-test.sh

【免费下载链接】catalogCatalog of shared Tasks and Pipelines.项目地址: https://gitcode.com/gh_mirrors/catalog3/catalog