release

Remotion Bits リリース

このスキルは、このリポジトリから新しい remotion-bits リリースを準備して公開するときに使用します。

このスキルで行うこと

このスキルでは、リリースワークフロー全体を実行します。

1. ./package.json のバージョンを更新します。ユーザーがマイナー、メジャー、または特定のバージョンを明示的に指定しない限り、パッチバージョンを上げます。
2. 新しいバージョンの簡潔なリリースノートを CHANGELOG.md に追加します。
3. npm run registry:build を実行します。
4. chore: vX.Y.Z でリリース変更をコミットします。
5. リリースコミットを master にプッシュします。
6. Git の履歴とマージ済み PR を調査して、前回のリリース以降の注目すべき変更を確認します。
7. 内部ブラウザーではなく、システムレベルのブラウザー起動コマンドで、事前入力済みの GitHub リリースフォームを開きます。
8. GitHub リリースの公開後、./scripts/deploy-docs.sh でドキュメントをデプロイします。
9. パッケージを 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. バージョンを更新してレジストリをビルドする

• ./package.json を新しいバージョンに更新します。
• 次を実行します。

npm run registry:build

• ビルドに失敗した場合は、続行する前に中断して根本原因を修正します。

4. リリースをコミットしてプッシュする

• リリース差分を確認します。
• 準備したリリースを次のコマンドでコミットします。

git commit -am "chore: vX.Y.Z"

• コミットを master にプッシュします。
• リポジトリがリモートより遅れている場合やプッシュに失敗した場合は、続行する前にその状態を解決します。

5. GitHub リリースの下書きを作成する

• changelog の概要と最近のコミットをもとに、リリースノートを作成します。
• 内部ブラウザーは使用せず、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.Z
  • target: master
  • title: vX.Y.Z
  • prerelease: 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 が正常に完了している。