新しいコードとドキュメントの開発
アクセス レベルによっては、新しいコードやドキュメントを新しい機能ブランチまたはフォークで開発することができます。 一般に、別のフォークから作業することが好ましく、場合によってはそれが唯一の選択肢です。
git/GitHub 開発のベスト プラクティスについては、このドキュメントでは説明しませんが、詳細についてはこちらを参照してください。
新規コード
プル要求 (PR) の送信
プル要求には、CI ビルド パイプラインを使用した手動実行を含める必要があります。 パイプラインは、PR にコメントを追加することでトリガーされます。 次のコマンドは、フル ビルドをトリガーします:
/azp run
変更がコードまたはドキュメントのいずれかに完全に限られていることがわかっている場合は、ビルドのその側のみを実行できます。 たとえば、コードの変更のみを確認するには:
/azp run wlt_ci
または、ドキュメントの変更のみを確認するには:
/azp run wlt_docs
ただし、コード (.cs) ファイルに制限された変更でも、ドキュメントの変更がトリガーされる可能性があるので注意してください。 フル ビルドを実行する方が、常に安全です。
PR に大幅な変更を加えた後、PR が最終的に完了する前に、適切なバージョンを実行します。 これらのツールは、共同作成者によるビルド破壊を防ぐために用意されていることに留意してください。 これらを使用することは、ユーザ自身にとって有益であり、同じスペースで作業する他のユーザーにとっても有益です。
コード レビュー
すべての PR は、完了前に別の開発者がレビューする必要があります。
コードレビューを実行するときは、友好的で、協調性のある雰囲気を維持してください。 対立している側が変更について前向きに感じるような提案や修正を表現する方法を見つけるには、いつでも少し余分な時間がかかります。
新しいリリースの公開
徹底的なテストと安定化を行った後、新しい 安全 なバージョンの製品を公開できます。
製品は、次の2つのチャネルを通じて提供されます:
- 検証済みリリース コミットのタグ付けされた、オープンソースの GitHub リポジトリを通じて。
- 公開済み
.unitypackage
ファイルを通じて。
どちらのチャネルも、WLTU の GitHub リリース ページで利用できます。
Unity パッケージのビルド
注: ここで説明するプロセスの正確な UI は、頻繁に変更される可能性があります。 画面に表示されている内容がここでのスクリーンショットと一致しない場合でも、おそらく問題ありません。 関連するキーワードを検索し、次の手順を実行します。
最初に、[ビルド パイプライン] ページにアクセスします。 "wlt_ci" が選択されていることを確認してください。
リリースの基礎となるコミットに一致するビルドを選択します。
この選択を行うと、次の画面が表示され、ビルド アーティファクトにアクセスできます。 *
Unity パッケージを選択します。
その後、zip としてダウンロードします。
パッケージをインストールしてテストした後は、新しいリリースに統合される可能性があります。
リリースの作成
コードのバージョン フィールドの更新
WorldLockingManager.Version フィールドを更新して、新しいバージョンを適切に反映します。
リリース ブランチの作成
たとえば、"release/v0.3.6-alpha" という名前のブランチを作成します。 タグを使用すると冗長になりますが、このブランチはリリースへのホット フィックスを容易にします。これは、メインの開発ブランチ "master" には適していません。
リリースの発行
Unity 用ワールド ロック ツールのリリース ページにアクセスします。
[新しいリリースの作成] ボタンをクリックします。
タグを指定してください。 タグは、vX. Y. Z [-プレリリース-修飾子] の形式で指定する必要があります。 このタグの X、Y、および Z は、 WorldLockingManager.Version フィールドで指定されているバージョンと一致する必要がある3つの整数です。 これらの番号は、リリース ブランチ名とも一致する必要があります。
上で作成したリリース ブランチをターゲットとして指定します。
[タイトル] フィールドと [説明] フィールドに適切に入力します。
上で作成した.unitypackage
ファイルを、[バイナリをここにドロップするか選択してアタッチする] というラベルの付いた長方形にドラッグします。
大きなサンプル パッケージには、MRTK 依存関係のスナップショットも含まれているため、アップロードにかなりの時間がかかる場合があります。 アップロードが正常に完了するまで、そのページを離れないことが最も安全です。
.unitypackage
ファイルが正常にアップロードされたら、[リリースの発行] ボタンをクリックします。
[リリース] ページですべてが正しく表示されていることを確認します。