Model Context Protocols

🚀 変更セット

このディレクトリには、変更セットが含まれており、モノレポ内のバージョン管理と変更ログの管理に使用されます。

🚀 クイックスタート

このドキュメントでは、変更セットを使用してモノレポ内のバージョン管理と変更ログを管理する方法について説明します。

✨ 主な機能

• リポジトリ内のパッケージの変更を記録することができます。
• 適切なバージョン番号の更新（メジャー、マイナー、パッチ）を自動的に決定します。
• 変更内容に基づいて変更ログを生成します。
• パッケージをnpmに公開することができます。

📦 インストール

このセクションでは、変更セットを使用するための手順について説明します。

変更セットの追加

パッケージに変更を加えた場合、それらの変更を説明するために変更セットを追加する必要があります。

`npm run changeset`を実行します。

これにより、以下のように促されます。

1. 変更されたパッケージを選択します（スペースキーで選択し、Enterキーで確定）。
2. 各パッケージに対して、バージョン番号の更新タイプを選択します。
   • major：重大な変更
   • minor：新機能（非破壊的）
   • patch：バグ修正と小さな変更
3. 変更の概要を記述します。 この概要は、パッケージが公開されるときに変更ログに含まれます。

パッケージのバージョン管理

新しいバージョンのパッケージを公開する準備ができたら、以下のコマンドを実行します。

`npm run version-packages`を実行します。

これにより、以下のことが行われます。

1. すべての変更セットを消費します。
2. パッケージのバージョンを更新します。
3. 変更ログを更新します。
4. これらの変更を含む新しいコミットを作成します。

パッケージの公開

パッケージをnpmに公開するには、以下のコマンドを実行します。

`npm run release`を実行します。

これにより、以下のことが行われます。

1. すべてのパッケージをビルドします。
2. パッケージをnpmに公開します。

📚 ドキュメント

CI/CD 統合

このリポジトリには、GitHubワークフローが設定されており、以下のことを行います。

1. 変更セットがメインブランチに追加されたときに、バージョン更新を含むPRを作成します。
2. PRをマージすると、パッケージをnpmに公開します。 このワークフローは、メインブランチに変更がプッシュされたときに自動的に実行されます。

ベストプラクティス

1. 必要に応じて変更セットを作成する：変更ログをより詳細で有用なものにするために、重要な変更を加えるたびに変更セットを作成します。
2. 意味のある変更セットメッセージを記述する：変更の内容と理由を説明し、単にファイルが何か変更されただけでなく、変更の意図を明確にします。
3. 適切なバンプタイプを使用する：
   • major：ユーザーがコードを更新する必要がある重大な破壊的変更
   • minor：既存の機能を破壊しない新機能
   • patch：バグ修正と小さな変更で、新機能を追加したり既存のコードを破壊したりしません。

トラブルシューティング

• 空の変更セットリスト：npm run changesetがパッケージを表示しない場合、パッケージに正しいpackage.jsonファイルがあり、nameとversionフィールドが含まれていることを確認してください。
• 公開エラー：公開が失敗した場合、正しいnpm資格情報があり、パッケージ名が使用可能であることを確認してください。
• 変更ログの衝突解消：衝突は、すべてのエントリを保持し、形式上の問題を修正することで解決できます。

詳細情報については、公式変更セットドキュメントを参照してください。