getsentry/craft

Craft: 通用发布工具（及更多功能）

craft 是一款命令行工具，用于自动化和流水线化包发布流程。它建议并强制实施特定的工作流，用于管理发布分支、变更日志、制品发布等任务。

核心功能

• 发布分支准备：通过 prepare 命令创建新的发布分支，支持预发布、发布前准备等场景
• 制品发布：通过 publish 命令发布制品到目标平台
• 工作流强制：建议并实施标准化的发布工作流程，确保发布过程一致性
• 灵活配置：支持环境变量配置，适配不同的开发环境和发布目标

使用场景

适用于需要自动化包发布流程的开发团队，特别是需要管理多平台发布、维护变更日志和协调发布分支的场景，尤其适合Sentry生态系统的项目。

使用方法

基本命令

bash
$ docker run --rm -v $(pwd):/workspace getsentry/craft -h
craft <command>

Commands:
  craft prepare NEW-VERSION  🚢 准备新的发布分支 [别名: p, prerelease, prepublish, prepare, release]
  craft publish NEW-VERSION  🛫 发布制品 [别名: pp, publish]

Options:
  --no-input     抑制所有用户提示 [boolean] [default: false]
  --dry-run       dry运行模式：不执行任何实际操作 [boolean] [default: false]
  -v, --version  显示版本号 [boolean]
  -h, --help     显示帮助 [boolean]

挂载工作目录

使用时需将当前工作目录挂载到容器的 /workspace 目录，以便工具访问项目文件：

bash
docker run --rm -v $(pwd):/workspace getsentry/craft <command>

注意事项

• 与远程GitHub仓库交互时，craft 默认使用 "origin" 远程仓库。若您的配置不同，可通过设置 CRAFT_REMOTE 环境变量指定其他远程仓库。

全局配置

craft 的全局配置通过环境变量实现。至少需要配置以下两个值以确保正常运行：

必要环境变量

• GITHUB_API_TOKEN
  个人GitHub API令牌，获取地址：https://github.com/settings/tokens
  令牌仅需 "repo" 权限（更精确地说，"repo:status" 和 "public_repo" 子权限）。

• ZEUS_API_TOKEN
  个人Zeus令牌，生成地址：[***]
  仅 craft publish 命令需要此令牌。

额外配置

发布到特定目标时可能需要额外配置（例如，发布到PyPI目标时需要 TWINE_USERNAME 和 TWINE_PASSWORD）。

完整文档

有关更多详细信息，请参见 https://github.com/getsentry/craft%E3%80%82