SuperAPI AI 工具集

deployment-checklist-generator

部署与运维

查看项目

更新于 10-15 18:37

技能介绍

用途

Deployment Checklist Generator 用于创建全面的部署检查清单,覆盖部署前检查、冒烟测试、验证步骤和签核工作流,目标是让部署过程更安全、更可靠。它适合在发布生产环境前,把关键检查项、自动化门禁和人工审批串联成可执行的流程。

主要能力

该技能可生成以下内容:

  • 部署前检查清单:涵盖代码质量、依赖、数据库、基础设施、文档、沟通和部署窗口等维度。
  • 带检查门禁的部署工作流:资料中给出了 GitHub Actions 的 YAML 示例,包括分支检查、CI 状态验证、部署窗口判断、预发环境健康检查、数据库备份、部署、冒烟测试、状态页更新和部署记录创建。
  • 冒烟测试脚本:资料中提供了 Bash 脚本示例,测试健康端点、用户登录、关键 API 端点、数据库连通性和外部服务。
  • 部署后验证清单:按时间窗口划分,包括立即检查(0-5 分钟)、短期监控(5-30 分钟)、功能验证、指标仪表盘和长期监控(1-24 小时)。
  • 签核模板:资料中给出了使用 manual-approval 动作请求部署审批的示例,包含审批人、最低审批数和审批说明。
  • 监控仪表盘:列出健康、性能、基础设施和业务指标,以及告警和最近部署记录。
  • 最佳实践:包括自动化检查、人工审查、冒烟测试、渐进式发布、监控、沟通和回滚准备。
  • 输出清单:部署前检查清单、带门禁的部署工作流、冒烟测试脚本、部署后验证、签核工作流、监控仪表盘、沟通模板和回滚说明。

使用方式

资料中展示的是清单和脚本示例,并未说明具体的安装命令或调用方式。用户可参考其中的检查项和代码模板,将其适配到自己的 CI/CD 流程中。例如,将 GitHub Actions 工作流放入 .github/workflows/deploy.yml,将冒烟测试脚本放入 scripts/smoke-tests.sh,并根据实际环境修改 URL、密钥和审批人。

适用场景

  • 需要为生产部署建立标准化检查清单的团队。
  • 希望在 CI/CD 中加入部署门禁和人工审批的工程组织。
  • 需要冒烟测试和部署后验证模板的运维或开发人员。
  • 需要规范部署沟通、监控和回滚准备的场景。

限制

资料中未提供该技能的安装方式、运行环境要求、收费信息或平台支持范围。示例中的 URL、密钥、审批人和服务名称均为占位内容,实际使用时需要替换。该技能本身不执行部署,而是生成清单和模板,具体效果取决于团队如何落地这些检查项。