Auth0 のバージョニング戦略

Auth0 のバージョニングの仕組みを理解します。

私たちは、バージョニングが提供サービスの重要な要素であると考えています。製品全体で一貫したバージョニング体系を提供することで、変更が利用にどのような影響を与えるかを、ユーザーが把握し予測できるよう支援しています。

​

セマンティックバージョニング

セマンティックバージョニング (semver とも呼ばれます) は、破壊的変更を判別しやすくすることを主な特徴とするバージョニングの方式です。バージョンは、ドットで区切られた 3 つの数字 .. で構成されます。たとえば、2.12.5、0.1.0、10.5.35 は有効な semver のバージョン番号です。

• 最初の数字は メジャー変更 を表します。これは、ライブラリの API が後方互換性のない形で変更されたことを意味します。バージョンのメジャー番号が上がると、そのライブラリの公開 API が変更されたことになります。たとえば、以前から非推奨とされていたコードや機能がコードベースから削除されます。
• 2 番目の数字は マイナー変更 を表します。これは、後方互換性を維持したまま、ライブラリの API に新機能が追加されたり、一部が非推奨になったりしたことを意味します。新しいマイナーバージョンは通常、安全に利用できると想定されるため、更新をおすすめしています。ただし、お客様ごとのコンポーネントの利用方法をすべて把握することは不可能なため、変更が現在の利用状況に影響する可能性は常にあります。そのため、更新前に確認とテストを行うことを推奨します。
• 3 番目の数字は パッチ変更 を表します。これは、不具合が修正されており、ユーザー向け API には影響しないことを意味します。通常は安全に更新できますが、テストの実施は常に推奨されます。

​

本番環境での利用

Auth0 では、一部のライブラリを配信している Content Delivery Network (CDN) へのリンクを提供しています。コード内でコンポーネントをどのように参照するかによって、変更が自動的に反映されるかどうか、また反映されるタイミングが変わります。たとえば、script 内でメジャーリリースにリンクしている場合、新しいマイナーリリースが出ると、公開され次第その更新が反映されます。開発環境や Auth0 の検証では、この方法を推奨しています。以下はソースファイルを埋め込む例です。

<!-- メジャーリリース -->
<script src="https://cdn.auth0.com/example/1/library.js"></script>

<!-- マイナーリリース -->
<script src="https://cdn.auth0.com/example/1.0/library.js"></script>

<!-- パッチリリース（本番環境での使用を推奨） -->
<script src="https://cdn.auth0.com/example/1.0.1/library.js"></script>

Auth0 のコンポーネントを本番環境にデプロイする際は、完全なバージョンに固定し、そのバージョンで十分にテストすることを推奨しています。後方互換性を保って新機能を追加する場合でも、通常はコードが壊れることはないものの、コンポーネントの動作との兼ね合いによっては予期しにくい影響が生じることがあります。些細なバグ修正であっても、コンポーネントに対してこれまで置いていた前提が変わり、もはや成り立たなくなる可能性があります。

semver に従う Auth0 の各オープンソースコンポーネントには、git リポジトリ内でリリース済みバージョンに対応するタグがあります。プロジェクトによっては npm のツールを使ってバージョンをリリースしているため、タグには接頭辞として v が付きます。たとえば、バージョン 5.2.3 のタグは v5.2.3 になります。

​

詳細情報

• 製品サポートマトリックス