Remotion Bits リリース
このリポジトリから新しい remotion-bits リリースを準備して公開するときにこのスキルを使用します。
このスキルの機能
このスキルは完全なリリースワークフローを実行します:
./package.jsonのバージョンをバンプします。デフォルトではパッチバンプとしますが、ユーザーが明示的に minor、major、または特定のバージョンをリクエストした場合はそれに従います。- 新しいバージョンの簡潔なリリースノートで
CHANGELOG.mdを更新します。 npm run registry:buildを実行します。chore: vX.Y.Zでリリース変更をコミットします。- リリースコミットを
masterにプッシュします。 - git 履歴とマージされた PR から、前回リリース以降の注目すべき変更を調査します。
- 内部ブラウザではなく、システムレベルのブラウザで事前入力された GitHub リリースフォームを開きます。
- GitHub リリースが公開された後、
./scripts/deploy-docs.shでドキュメントをデプロイします。 npm publishでパッケージを npm に公開します。
前提条件
- リポジトリルートから作業します。
- docs 開発サーバーを起動しないでください。
- リリース公開には、有効な GitHub、Cloudflare、npm の認証情報が環境に既に設定されていることを前提とします。
- ワーキングツリーに無関係なユーザー変更が含まれている場合、それらを元に戻さないでください。影響を回避するか、リリースファイルに影響する場合は中断して確認を求めてください。
リリースワークフロー
1. ターゲットバージョンの決定
./package.jsonから現在のバージョンを読み取ります。- ユーザーが特定のバージョンを指定した場合はそれを使用します。
- ユーザーがバンプ種別を指定した場合はそれを適用します。
- それ以外の場合はパッチバンプとします。
- git タグとリリースタイトルは
vX.Y.Zとします。
2. リリースノートの準備
- 最後にリリースされたタグ以降のコミットを確認します。
- 変更の要約に役立つ場合は、マージされた PR を確認します。
- 新しいバージョンのセクションを先頭に挿入して
CHANGELOG.mdを更新します。 - エントリは簡潔でユーザー向けに保ちます。
- 次のフォーマットを使用します:
### vX.Y.Z
- 機能:新機能の簡単な説明
- 修正:バグ修正の簡単な説明
- 改善:拡張の簡単な説明
- ドキュメント:ドキュメント変更の簡単な説明
3. バージョンバンプとレジストリのビルド
./package.jsonを新しいバージョンに更新します。- 実行:
npm run registry:build
- ビルドが失敗した場合は、続行する前に停止して根本的な問題を修正します。
4. リリースのコミットとプッシュ
- リリース差分を確認します。
- 準備したリリースをコミットします:
git commit -am "chore: vX.Y.Z"
- コミットを
masterにプッシュします。 - リポジトリがリモートより遅れているかプッシュに失敗した場合は、続行する前にその状態を解決します。
5. GitHub リリースの下書き
- 変更ログの要約と最近のコミットからリリースノートを作成します。
xdg-openまたはその他のシステムレベルの 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
-
リリース本文は次の構造に従う必要があります:
## 変更点
- 注目すべき新機能ごとに 1 つの短い文。
- 注目すべきバグ修正ごとに 1 つの短い文。
- 注目すべき改善ごとに 1 つの短い文。
**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が正常に完了しました。