メインコンテンツへスキップ
Auth0 では、バージョニングは提供内容の重要な要素であると考えており、製品全体で一貫したバージョニング体系を提供できるよう取り組んでいます。これにより、ユーザーは変更が利用にどのような影響を与えるかを把握し、予測できます。

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

セマンティック バージョニング (semver とも呼ばれます) は、breaking changes を識別しやすくすることを主な特徴とするバージョニング戦略です。バージョンは、ドットで区切られた 3 つの数値 .. で構成されます。たとえば、2.12.5、0.1.0、10.5.35 はいずれも有効な semver のバージョン番号です。
  • 1 番目の数字は major change を表します。これは、ライブラリ API が後方互換性のない形で変更されたことを意味します。バージョンの major 部分が上がると、そのライブラリの公開 API が変更されたことになります。たとえば、以前から非推奨とされていた code や機能がコードベースから削除されます。
  • 2 番目の数字は minor change を表します。これは、後方互換性を維持したまま、ライブラリ API に新機能が追加された、または非推奨としてマークされたことを意味します。新しい minor バージョンは安全に利用できることが想定されているため、お客様には更新を推奨しています。ただし、お客様によるコンポーネントの利用方法をすべて把握することは不可能であるため、変更が現在の利用状況に影響を及ぼす可能性は常にあります。そのため、更新前に確認とテストを実施することを推奨します。
  • 3 番目の数字は patch change を表します。これは、不具合が修正され、ユーザー向け API に影響を及ぼさないはずの変更です。通常は安全に更新できますが、テストの実施は引き続き推奨されます。

本番環境での利用

Auth0 は、一部のライブラリを配信している Content Delivery Network (CDN) へのリンクを提供しています。コード内でコンポーネントをどのように参照するかによって、変更が自動的に反映されるかどうか、また、いつ反映されるかが決まります。たとえば、スクリプト内でメジャーリリースを参照している場合、新しいマイナーリリースが公開されると、その更新は公開され次第自動的に適用されます。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 になります。

詳しく見る