SuperAPI AI 工具集

dev-workflow

编程与开发

查看项目

更新于 10-15 20:27

技能介绍

用途:面向 Contentstack Python CDA SDK 的开发工作流,适用于本地环境搭建、提交 PR、对齐 CI 预期、回答如何运行测试或 CI 执行内容,以及为发布提升 SDK 版本。

分支与发布:流程为 feature/fix 分支 → staging → master;从 feature 分支直接向 master 提交 PR 会被 .github/workflows/check-branch.yml 拒绝。PyPI 发布通过创建 GitHub Release 触发 .github/workflows/python-publish.yml。

提交 PR 前:先执行 pip install -r requirements.txt,再执行 pip install -e . 进行可编辑安装。在仓库根目录运行 pytest tests/(或 python -m pytest tests/),tests/pytest.ini 会生效。集成测试使用仓库根目录的 config.py 配置 HOST、APIKEY、DELIVERYTOKEN、ENVIRONMENT 等,仅使用本地凭据,切勿提交真实令牌。

版本管理:任何用户可见的 SDK 变更,需按 semver 在 contentstack/init.py 中提升 version。

pre-commit 钩子:Talisman 在提交前扫描密钥(.talismanrc);Snyk 检查依赖漏洞(snyk test --all-projects --fail-on=all)。两个钩子位于 .husky/pre-commit,仅在合理情况下可用 SKIP_HOOK=1 跳过。

限制:资料未提供更多平台、收费或效果信息。