tenzir-ship

tenzir-ship

このスキルには、tenzir-ship を使った主要なリリースエンジニアリングのユースケースがまとめられています。

変更履歴

リリース済みの変更履歴データは、公開済みの記録として扱ってください。 changelog/releases/ 以下のファイル（リリースノート、マニフェスト、リリースエントリーファイルを含む）は、GitHub のリリース、パッケージレジストリ、ドキュメント、下流のコピーにすでに存在する可能性があるため、公開後は変更できません。

通常のフォローアップ作業では、既存の履歴の先頭に新しい変更履歴エントリーを追加してください。 過去のリリース成果物を編集できるのは、法的または運用上の危険がある内容など、公開に関する重大な不備がある場合に限ります。また、その修正をユーザーが明示的に依頼した場合のみ編集してください。

利用可能なスクリプト

• bash <skill-dir>/scripts/detect-change-scope.sh：現在の変更履歴の対象範囲を検出します。変更履歴エントリーを追加する前に実行し、ステージ済み、未ステージ、またはブランチの変更のうち、どれをエントリーに反映するかを特定してください。このスクリプトは、推奨する diff コマンドと対象範囲内のファイルを表示します。

ユースケース

変更履歴プロジェクトを初期化する

最初のエントリーを作成する前に、新しい変更履歴のワークスペースを設定します。エントリーの作成ではなくプロジェクトのセットアップが目的の場合は、明示的な init コマンドを優先してください。

手順：references/init-changelog-project.md

変更履歴エントリーを追加する

日々の開発において、バグ修正、変更、機能のリリースに伴い、変更履歴エントリーを追加します。

手順：references/add-changelog-entry.md

リリースを作成する

リリースには次の2種類があります。

1. リモート：CI ワークフローをトリガーします
2. ローカル：ローカルリポジトリからリリースします

ワークフローが存在する場合はリモートリリースを優先し、存在しない場合はローカルリリースを使用してください。

ドキュメント

リリースプロセス中にエラーが発生した場合は、公式ドキュメントを参照して詳細なサポートを得てください。

• https://docs.tenzir.com/reference/ship-framework.md
• https://docs.tenzir.com/guides/packages/maintain-a-changelog.md