kscout/serverless-registry-api

Serverless Registry API

用于管理Serverless应用的API服务，支持应用数据的存储、验证及与GitHub生态的集成。

概述

该API服务负责维护Serverless应用注册表，提供数据管理、合规验证及与GitHub应用的交互能力，确保注册表中应用的规范性。

核心功能

• 数据管理：通过MongoDB存储Serverless应用信息，支持数据导入与种子数据初始化
• GitHub集成：与GitHub应用联动，处理拉取请求验证、Webhook事件响应
• 合规验证：检查应用格式规范性，自动设置PR检查状态并评论结果
• 部署支持：提供生产/ staging环境部署流程及配置管理

使用场景

• 本地开发调试Serverless应用注册表服务
• 部署生产环境的Serverless应用管理平台
• 自动化验证GitHub仓库中Serverless应用的合规性

配置说明

环境变量配置

核心配置项需通过环境变量设置：

• APP_BOT_API_SECRET：与Bot API交互的认证密钥
• APP_GH_INTEGRATION_ID：GitHub应用ID
• APP_GH_INSTALLATION_ID：GitHub应用安装ID
• APP_GH_WEBHOOK_SECRET：GitHub Webhook密钥
• 其他配置项（如数据库地址、端口等）可使用默认值或按需调整

本地运行步骤

1. 启动MongoDB数据库：

bash
make db

2. 设置必要的环境变量（如上述核心配置项）
3. 运行API服务：

bash
go run .

高级运行命令

• 强制更新应用数据：

bash
go run . -update-apps

• 插入种子数据：

bash
go run . -seed

• 验证GitHub PR合规性：

bash
go run . -validate-pr PR_NUM

部署说明

GitHub应用创建

需创建GitHub应用并配置以下权限：

• Checks：读写权限
• Repository contents：只读权限
• Pull requests：读写权限 订阅事件：Check run、Pull request

部署步骤

1. 初始化子模块：

bash
git submodule update --init --recursive

2. 部署生产环境：

bash
make deploy-prod
make rollout-prod

3. 部署Staging环境：

bash
make deploy-staging
make rollout-staging
make push

部署状态跟踪

通过GitHub部署页面查看当前环境的提交状态，创建部署状态命令：

bash
make gh-deploy