微信扫一扫article
README
🚀 GitHub Action 操作指南
本指南详细介绍了如何使用一系列工具对 GitHub 仓库进行操作，包括获取仓库中的操作、工作流、发布版本等，以及如何触发工作流和删除发布版本。
🚀 快速开始
工具使用说明
以下是不同操作对应的工具及其使用方法：
- 获取仓库中的操作：使用
get_github_action工具获取指定仓库中的操作。 - 获取具体操作的详细信息：使用
get_github_action_info工具获取指定操作的具体信息。 - 触发 GitHub 工作流：使用
trigger_github_workflow工具触发指定的 GitHub 工作流。 - 获取仓库中的工作流：使用
list_github_workflows工具获取指定仓库中的所有工作流。 - 获取仓库的最新发布版本：使用
get_github_release工具获取指定仓库的最新发布版本。 - 获取仓库的所有发布版本：使用
list_github_releases工具获取指定仓库的所有发布版本。 - 删除仓库的发布版本：使用
delete_github_release工具删除指定仓库的特定发布版本。
💻 使用示例
1. 获取仓库中的操作
请求格式
{
"owner": "仓库所有者",
"repo": "仓库名称"
}
示例响应
{
"count": 2,
"actions": [
{
"name": "构建项目",
"description": "使用 Node.js 构建项目并生成构建包。",
"author": "GitHub Actions 团队",
"inputs": [
{
"名称": "源代码分支",
"描述": "要构建的源代码分支，默认值: main",
"是否必填": true
},
{
"名称": "目标目录",
"描述": "构建输出的目标目录。",
"默认值": "dist",
"是否必填": false
}
],
"runs": {
"运行环境": "node16",
"主文件": "scripts/build.js"
}
},
{
"name": "运行测试",
"description": "执行项目中的所有单元测试。",
"author": "GitHub Actions 团队",
"inputs": [
{
"名称": "测试环境",
"描述": "指定测试环境（开发/生产）。",
"默认值": "开发",
"是否必填": false
}
],
"runs": {
"运行环境": "node16",
"主文件": "scripts/test.js"
}
}
]
}
2. 获取具体操作的详细信息
请求格式
{
"owner": "操作所有者",
"repo": "操作仓库名称",
"action_id": "操作ID"
}
示例响应
{
"name": "构建项目",
"description": "使用 Node.js 构建项目并生成构建包。",
"author": "GitHub Actions 团队",
"inputs": [
{
"名称": "源代码分支",
"描述": "要构建的源代码分支，默认值: main",
"是否必填": true
},
{
"名称": "目标目录",
"描述": "构建输出的目标目录。",
"默认值": "dist",
"是否必填": false
}
],
"runs": {
"运行环境": "node16",
"主文件": "scripts/build.js"
},
"usage_count": 500,
"rating": 4.8,
"review_count": 231
}
3. 触发 GitHub 工作流
请求格式
{
"owner": "仓库所有者",
"repo": "仓库名称",
"workflow_id": "工作流文件名",
"inputs": {
"参数1": "值1",
"参数2": "值2"
}
}
示例响应
{
"success": true,
"message": "工作流触发成功。",
"run": {
"id": 12345678,
"url": "https://github.com/owner/repo/actions/runs/12345678",
"状态": "排队中",
"结论": null,
"创建时间": "2025-03-19T06:45:12Z",
"触发人": "user1"
}
}
4. 获取仓库中的工作流
请求格式
{
"owner": "仓库所有者",
"repo": "仓库名称"
}
示例响应
{
"count": 3,
"workflows": [
{
"name": "每日构建检查",
"description": "每天定时运行构建和测试。",
"creator": "GitHub Actions 团队",
"created_at": "2024-01-01T00:00:00Z"
},
{
"name": "合并请求检查",
"description": "在每次合并请求时运行检查。",
"creator": "开发团队",
"created_at": "2024-06-01T00:00:00Z"
},
{
"name": "每周报告生成",
"description": "每周生成项目报告并发送到Slack频道。",
"creator": "数据团队",
"created_at": "2024-03-01T00:00:00Z"
}
]
}
5. 获取仓库的最新发布版本
请求格式
{
"owner": "仓库所有者",
"repo": "仓库名称"
}
示例响应
{
"tag_name": "v1.0.0",
"name": "项目发行版1.0.0",
"body": "## 发行说明\n- 新增功能A\n- 优化性能\n- 修复已知bug",
"author": "开发团队",
"published_at": "2024-10-01T00:00:00Z"
}
6. 获取仓库的所有发布版本
请求格式
{
"owner": "仓库所有者",
"repo": "仓库名称"
}
示例响应
{
"count": 5,
"releases": [
{
"tag_name": "v1.0.0",
"name": "项目发行版1.0.0",
"body": "## 发行说明\n- 新增功能A\n- 优化性能\n- 修复已知bug",
"author": "开发团队",
"published_at": "2024-10-01T00:00:00Z"
},
{
"tag_name": "v0.9.0",
"name": "项目发行版0.9.0",
"body": "## 发行说明\n- 初始版本发布",
"author": "开发团队",
"published_at": "2024-09-01T00:00:00Z"
},
{
"tag_name": "v0.8.0",
"name": "项目发行版0.8.0",
"body": "## 发行说明\n- 修复一些小问题",
"author": "开发团队",
"published_at": "2024-08-01T00:00:00Z"
},
{
"tag_name": "v0.7.0",
"name": "项目发行版0.7.0",
"body": "## 发行说明\n- 增加新功能B",
"author": "开发团队",
"published_at": "2024-07-01T00:00:00Z"
},
{
"tag_name": "v0.6.0",
"name": "项目发行版0.6.0",
"body": "## 发行说明\n- 优化代码结构",
"author": "开发团队",
"published_at": "2024-06-01T00:00:00Z"
}
]
}
7. 删除仓库的发布版本
请求格式
{
"owner": "仓库所有者",
"repo": "仓库名称",
"tag_name": "要删除的版本号"
}
示例响应
{
"message": "删除成功",
"deleted_tag": "v0.6.0"
}
⚠️ 注意事项
⚠️ 重要提示
- 权限要求：执行这些操作需要有相应的权限。例如，删除发布版本可能需要更高的权限。
- API限制：某些操作可能会受到API速率限制的影响，具体取决于GitHub的设置和您的计划（如免费层、Pro层等）。
- 验证信息：确保您提供的身份验证信息（如token）是有效的，并且具有执行相应操作的权限。