SuperAPI AI 工具集

dev-workflow

部署与运维

查看项目

更新于 10-15 20:27

技能介绍

用途:说明 contentstack-cli-tsgen 的开发工作流,帮助贡献者了解何时运行规范构建、哪些分支运行 CI 以及发布如何进行。

分支与 CI:Node.js 工作流(.github/workflows/node.js.yml)在 master、development、staging 分支的 push 和 pull_request 时运行。发布工作流(.github/workflows/release.yml)在 push 到 master 时运行(Node 22.x),从 lib 发布 npm 产物并创建 GitHub release。其他 Contentstack 仓库可能使用 main 而非 master,贡献时应与团队的分支保护规则保持一致。

构建:npm run prepack 会删除 lib/、运行 tsc -b、oclif manifest、oclif readme,这是打包或发布前的规范编译步骤。CI 在全局 csdx 设置及适用时的 plugins:link 之后运行 prepack。

测试与 lint:npm test 使用 Jest 并带 --testPathPattern=tests。posttest(在 npm test 之后运行)使用 .eslintrc.js 执行 ESLint 并带 --fix。

Pull request:修改源码或测试时,运行 npm run prepack 和 npm test(会触发 posttest)。

发布:package.json 中的版本号驱动发布;发布工作流在 master 上使用 prepack 构建。

限制:资料未提供更多关于环境要求、失败处理或权限配置的细节。