关于 alicloud-platform-devops
用于通过 Alibaba Cloud DevOps OpenAPI 执行云效项目、代码仓库和流水线等操作,面向需要检查研发资源与发布状态的团队。它支持先查询 API 元数据,再进行只读检查或经确认的变更,并保存操作证据。
主要功能
- 01发现并列出 OpenAPI 元数据
- 02盘点项目、仓库和流水线
- 03检查工作项与测试资源
- 04查询发布和执行状态
- 05保存操作参数与响应证据
适用场景
- 01盘点组织中的项目与代码仓库
- 02检查流水线和发布执行状态
- 03通过 API 元数据确认接口及参数
- 04在确认回滚方案后执行变更
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ cinience/ alicloud-skills --skill alicloud-platform-devops安装后在 Claude Code 中输入/alicloud-platform-devops确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
agents/openai.yamlreferences/api_quick_map.mdsources.mdtemplates.mdscripts/_devops_client.pylist_openapi_meta_apis.pylist_pipelines.pylist_projects.pylist_repositories.py详细介绍
Category: 服务
阿里云 DevOps(云效)
用途
使用阿里云 DevOps OpenAPI 支持以下操作:
- 项目、代码库和流水线清单
- 工作项和测试资源检查
- 发布和执行状态检查
- 生产变更前基于元数据发现 API
先决条件
- 配置遵循最小权限原则的阿里云凭证。
- 为本地脚本安装 Python SDK 依赖项:
python3 -m venv .venv
. .venv/bin/activate
python -m pip install -U alibabacloud_devops20210625 alibabacloud_tea_openapi
- 优先使用环境变量:
ALICLOUD_ACCESS_KEY_IDALICLOUD_ACCESS_KEY_SECRET- 可选的
ALICLOUD_REGION_ID
AccessKey 优先级
- 环境变量:
ALICLOUD_ACCESS_KEY_ID/ALICLOUD_ACCESS_KEY_SECRET/ALICLOUD_REGION_ID - 共享凭证文件:
~/.alibabacloud/credentials
如果区域或环境不明确,请在执行变更操作前与用户确认。
工作流
- 确认目标组织/项目范围和变更窗口。
- 运行 API 发现,并确认确切的 API 名称和必需参数。
- 优先运行只读 API(
List*/Get*/Query*)。 - 仅在确认回滚方案并获得负责人确认后,运行变更 API。
- 将输出和证据保存到
output/alicloud-platform-devops/。
API 发现
- 产品代码:
devops - 默认 API 版本:
2021-06-25 - 元数据来源:
https://api.aliyun.com/meta/v1/products/devops/versions/2021-06-25/api-docs.json
最简可执行快速入门
python skills/platform/devops/alicloud-platform-devops/scripts/list_openapi_meta_apis.py
可选参数:
python skills/platform/devops/alicloud-platform-devops/scripts/list_openapi_meta_apis.py \
--product-code devops \
--version 2021-06-25 \
--output-dir output/alicloud-platform-devops
列出项目(只读):
python skills/platform/devops/alicloud-platform-devops/scripts/list_projects.py \
--organization-id <organization-id> \
--region cn-hangzhou \
--max-results 20 \
--output output/alicloud-platform-devops/projects.txt
列出代码库(只读):
python skills/platform/devops/alicloud-platform-devops/scripts/list_repositories.py \
--organization-id <organization-id> \
--region cn-hangzhou \
--page 1 \
--per-page 20 \
--output output/alicloud-platform-devops/repositories.txt
列出流水线(只读):
python skills/platform/devops/alicloud-platform-devops/scripts/list_pipelines.py \
--organization-id <organization-id> \
--region cn-hangzhou \
--max-results 20 \
--output output/alicloud-platform-devops/pipelines.txt
常见操作对照表
- 项目和成员:
CreateProject、GetProject、ListProjectMembers、UpdateProject - 代码库:
CreateRepository、GetRepository、ListRepositories、CreateMergeRequest - 流水线和发布:
CreatePipeline、GetPipeline、ListPipelines、RunPipeline - 工作项和测试:
CreateWorkitem、GetWorkitemDetail、ListTestCase、CreateTestCase
分组 API 参见 references/api_quick_map.md。
脚本目录
scripts/list_openapi_meta_apis.py:获取元数据并生成 API 清单文件。scripts/list_projects.py:列出一个组织中的项目。scripts/list_repositories.py:列出一个组织中的代码库。scripts/list_pipelines.py:列出一个组织中的流水线。
验证
mkdir -p output/alicloud-platform-devops
for f in skills/platform/devops/alicloud-platform-devops/scripts/*.py; do
python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/alicloud-platform-devops/validate.txt
通过标准:命令以 0 退出,且生成 output/alicloud-platform-devops/validate.txt。
输出和证据
- 将产物、命令输出和 API 响应摘要保存到
output/alicloud-platform-devops/下。 - 在证据文件中包含关键参数(区域/资源 ID/时间范围),以便复现。
参考资料
- 来源列表:
references/sources.md - API 快速对照表:
references/api_quick_map.md - 操作模板:
references/templates.md
评论
支持 Markdown