mcpField
P
pipeline-plugin-development

pipeline-plugin-development

github.com/tencentblueking開発2.5k40 回インストール1 日前に更新
リポジトリ

pipeline-plugin-development について

パイプラインプラグインの開発者向けスキルで、プラグイン定義、契約設計、実装、デバッグ、公開を扱います。`task.json` とプラグイン本体に焦点を置き、Worker などの実行経路は対象外です。

主な機能

  1. 01プラグイン構造とディレクトリの案内
  2. 02`task.json` と入出力契約の設計
  3. 03エラーコードと機密フィールドの扱い
  4. 04複数言語での実装方法
  5. 05デバッグ、テスト、公開の手順

活用シーン

  1. 01パイプラインプラグインの追加や設定項目の変更
  2. 02プラグインの入出力とエラーコードの定義
  3. 03プラグインのデバッグ、テスト、公開

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/tencentblueking/bk-ci --skill pipeline-plugin-development

インストール後、Claude Code で/pipeline-plugin-developmentを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

reference/
1-plugin-foundation.md
2-task-json-io.md
3-debug-publish-practice.md

詳細

プロジェクトの README より

流水线插件开发

适用场景

  • 新增一个流水线插件
  • 修改 task.json 配置和字段定义
  • 设计插件输入、输出、错误码和敏感字段
  • 选择 Java、Python、NodeJS、Golang 等插件实现方式
  • 调试、测试、发布或排查插件行为

不适用场景

  • 修改 Worker 如何执行插件
  • 修改 Agent 如何拉起 Worker
  • 修改 Dispatch 如何调度构建机
  • 修改流水线模型、YAML 转换或模板体系

快速指导

  1. 这个 skill 关注的是“插件本体怎么定义和交付”,不是“插件如何被执行”。
  2. 先确认你是在开发 Atom,而不是在改执行器链路。
  3. 开发插件时优先看三类信息:
    • 插件基础与目录:reference/1-plugin-foundation.md
    • task.json、输入输出与错误码:reference/2-task-json-io.md
    • 调试、发布与最佳实践:reference/3-debug-publish-practice.md
  4. task.json 是插件契约,字段设计、运行时配置、敏感信息标记都应先在这里定清楚。
  5. 输入输出要以“稳定契约”为目标,不要把临时实现细节暴露给使用者。
  6. 运行时和目标平台要尽量前置明确,避免发布后再补兼容。
  7. 如果问题发生在插件被下载、执行、打日志或归档产物的阶段,通常要切到 worker-module-architecture。

高信号规则

  • 插件开发的核心对象是 task.json 和插件执行入口
  • 输入字段、输出变量、错误码属于对使用者可见的契约
  • 多语言只是实现手段,契约稳定性比语言选择更重要
  • 插件发布后会被很多流水线复用,兼容性和向后兼容要优先考虑

关键陷阱

  • 把执行器问题误判成插件问题
  • task.json 塞入过多前端/运行时细节,导致难以维护
  • 忽略敏感字段、默认值和校验规则
  • 先写实现,后补契约,最后导致输入输出不稳定

延伸阅读

  • 插件基础与目录:reference/1-plugin-foundation.md
  • task.json、输入输出与错误码:reference/2-task-json-io.md
  • 调试、发布与最佳实践:reference/3-debug-publish-practice.md
  • 如果问题出在执行阶段:再看 worker-module-architecture
  • 如果问题出在流水线模型:再看 pipeline-model-architecture

コメント