关于 release
release 是 Remotion Bits 仓库中的发布技能,用于准备并发布一个新版本。它涵盖版本号、变更日志、构建、提交推送、GitHub 发布、文档部署和 npm 发布,并要求在需要人工确认或凭据缺失时暂停。
主要功能
- 01更新 package.json 版本和 CHANGELOG.md
- 02运行 registry 构建命令
- 03提交发布变更并推送到 master
- 04准备 GitHub 发布表单
- 05发布后部署文档
- 06将包发布到 npm
适用场景
- 01从仓库准备一个新版本发布
- 02根据提交记录整理发布说明
- 03在人工发布或凭据缺失处暂停流程
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ av/ remotion-bits --skill release安装后在 Claude Code 中输入/release确认已加载。
详细介绍
Remotion Bits 发布
在准备并发布此仓库的新 remotion-bits 版本时使用此技能。
此技能的作用
此技能会执行完整的发布工作流:
- 更新
./package.json中的版本。除非用户明确要求次要版本、主要版本或指定版本,否则默认递增补丁版本。 - 更新
CHANGELOG.md,为新版本编写简洁的发布说明。 - 运行
npm run registry:build。 - 使用
chore: vX.Y.Z提交发布变更。 - 将发布提交推送到
master。 - 通过 Git 历史记录和已合并的 PR 研究自上次发布以来的重要变更。
- 使用系统级浏览器打开预填内容的 GitHub 发布表单,而非内部浏览器。
- 发布 GitHub 版本后,使用
./scripts/deploy-docs.sh部署文档。 - 将软件包发布到 npm:
npm publish。
前提条件
- 在仓库根目录中操作。
- 不要启动文档开发服务器。
- 假定环境中已配置有效的 GitHub、Cloudflare 和 npm 凭据,以便发布。
- 如果工作区包含无关的用户变更,不要还原这些变更。如果这些变更影响发布文件,请设法避开;否则先停止并询问,再进行操作。
发布工作流
1. 确定目标版本
- 从
./package.json中读取当前版本。 - 如果用户指定了版本,则使用该版本。
- 如果用户指定了递增类型,则按该类型递增。
- 否则递增补丁版本。
- Git 标签和发布标题必须为
vX.Y.Z。
2. 准备发布说明
- 查看自上一个已发布标签以来的提交。
- 如果有助于总结变更,则查看已合并的 PR。
- 更新
CHANGELOG.md,在顶部插入新版本章节。 - 条目应简洁,并面向用户。
- 使用以下格式:
### vX.Y.Z
- Feature: Brief description of new feature
- Fix: Brief description of bug fix
- Improvement: Brief description of enhancement
- Docs: Brief description of documentation change
3. 更新版本并构建 Registry
- 将
./package.json更新为新版本。 - 运行:
npm run registry:build
- 如果构建失败,请停止并修复根本问题后再继续。
4. 提交并推送发布变更
- 检查发布差异。
- 使用以下命令提交准备好的发布变更:
git commit -am "chore: vX.Y.Z"
- 将提交推送到
master。 - 如果仓库落后于远程,或推送失败,请先解决问题再继续。
5. 起草 GitHub 发布内容
- 根据变更日志摘要和近期提交编写发布说明。
- 使用
xdg-open或其他系统级打开命令打开此 URL,绝不要使用内部浏览器:
https://github.com/everlier/remotion-bits/releases/new?tag=vX.Y.Z&target=master&title=vX.Y.Z&body=...
-
在表单中预填:
tag:vX.Y.Ztarget:mastertitle:vX.Y.Zprerelease:false
-
发布正文应遵循以下结构:
## What's Changed
- One short sentence per notable new feature.
- One short sentence per notable bugfix.
- One short sentence per notable improvement.
**Full Changelog**: https://github.com/everlier/remotion-bits/compare/vX.Y.(Z-1)...vX.Y.Z
- 如果需要在浏览器中确认,请暂停并等待用户发布 GitHub 版本。
6. 部署文档
- GitHub 版本发布后,运行:
./scripts/deploy-docs.sh
7. 发布到 npm
- 确认 npm 身份验证可用。
- 在仓库根目录中发布:
npm publish
决策规则
- 除非用户另有说明,否则默认发布补丁版本。
- 如果发布说明不明确,请先根据提交历史整理,再询问用户。
- 如果命令会修改发布产物,请将生成的变更保留在发布提交中。
- 如果发布需要手动执行浏览器操作,请在此处暂停,准确告知用户当前等待的操作,并在用户确认后继续。
- 如果缺少 GitHub、Cloudflare 或 npm 凭据,请停止并报告缺失的前提条件,不要盲目重试。
完成检查清单
package.json已设置为目标版本。CHANGELOG.md顶部已有该版本的新章节。npm run registry:build已成功完成。- 发布提交
chore: vX.Y.Z已创建并推送到master。 - 已使用正确的预填值打开 GitHub 发布表单。
- 文档部署已完成。
npm publish已成功完成。
评论
支持 Markdown