テンプレートリポジトリのセットアップ

テンプレートリポジトリは、チームがアプリケーション開発に使用できるスターターテンプレートを含む Git リポジトリです。

つまり、組織またはチーム内で、組織向けに Cloud Code でテンプレートリポジトリを設定して、他のユーザーが使用できる標準のスターターアプリケーション、サービス、インフラストラクチャ構成をまとめて提供できます。これにより、新しいプロジェクトが組織推奨の技術スタックと標準に合わせて表示され、開発サイクルの開始時にベストプラクティスが組み込まれます。

テンプレートリポジトリは、すでに作成したアプリケーションテンプレートの既存のリポジトリであったり、他の人に使ってもらいたいテンプレートの新しいセットであったりします。Cloud Code でインポートする場合、テンプレート記述子ファイルをリポジトリに追加するだけで実行できます。

準備ができたら、テンプレートリポジトリはチームで簡単に共有できます。Cloud Code の設定と、使用するテンプレートリポジトリの Git URL が必要です。プライベート Git リポジトリでは、そのリポジトリにアクセスできるメンバーだけが基礎となるカスタムテンプレートを使用できます。

テンプレートリポジトリの設定例については、こちらのサンプルリポジトリをご覧ください。

新しいテンプレートリポジトリの作成

新しいテンプレートリポジトリを作成する場合は、次の手順を行います。

新しい Git リポジトリを作成する。

Git リポジトリは、リモートまたはローカルマシンでホストできます。この例では、新しい GitHub リポジトリ「my-template-repository」を使用します。
このリポジトリにテンプレートディレクトリを追加する。

テンプレートディレクトリには、任意の情報を含めることができ、リポジトリ内の任意の場所に配置できます。この例では、readme ファイルを含む 2 つのテンプレートディレクトリ「template1」と「template2」が「my-template-repository」に追加されました。

カスタムテンプレートの使用方法が解説されている readme ファイルを使用することを強くおすすめします。
テンプレート記述子ファイルを作成する。

テンプレート記述子ファイルは、アプリケーションを適切に作成するためのテンプレートに関する情報を Cloud Code に提供します。このファイルには、ルートディレクトリにある .cctemplate という名前が付けられ、テンプレート記述子ファイルスキーマセクションで定義されているスキーマが必要です。

既存のリポジトリの使用

既存のテンプレートリポジトリを使用する場合も、テンプレート記述子ファイルを作成する必要があります。このファイルは、アプリケーションを適切に作成するためのテンプレートに関する情報を Cloud Code に提供します。

テンプレート記述子ファイルには、ルートディレクトリにある .cctemplate という名前が付けられ、テンプレート記述子ファイルスキーマセクションで定義されているスキーマが必要です。

テンプレート記述子スキーマ

鍵	説明	型
メタデータ	Cloud Code が読み取りに使用するメタデータ。メタデータスキーマに準拠します。	メタデータ
テンプレート	リポジトリに含まれるテンプレートの配列。この配列内のオブジェクトは、テンプレートスキーマに準拠している必要があります。	配列<テンプレート>
名前（省略可）	テンプレートリポジトリの名前。	String（文字列）

例

{
   "metadata":{
      "version":"1"
   },
   "name": "My Template Repository",
   "templates":[
      {
         "path":"/path/to/template1_location",
         "name":"My Template 1",
         "description":"The first template of its name."
      },
      {
         "path":"/path/to/template2_location",
         "name":"My Template 2",
         "description":"The sequel."
      }
   ]
}

テンプレートスキーマ

鍵	説明	型
パス	テンプレートがリポジトリ内のどこに配置されるか。このパスは、リポジトリのルートからのものとして解釈されます。	String（文字列）
名前	テンプレートの名前。これは、アプリをベースとするテンプレートを選択した場合に、IDE に表示されます。	String（文字列）
説明（省略可）	テンプレートの説明。これは、アプリをベースとするテンプレートを選択した場合に、IDE に表示されます。	String（文字列）

例

{
   "path":"path/to/template1",
   "name":"My Template 1",
   "description":"The first template of its name."
}

メタデータスキーマ

鍵	説明	型
バージョン	使用されているテンプレートスキーマのバージョン。現時点で有効なバージョンは `1` のみです。	String（文字列）

例

{
   "version":"1"
}

サポートの利用

フィードバックを送信するには、GitHub で問題を報告します。または、Stack Overflow で質問します。

テンプレート リポジトリのセットアップ

新しいテンプレート リポジトリの作成