Cloud Code for VS Code でカスタムサンプルリポジトリを管理する

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

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

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

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

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

始める前に

Git バージョン 2.25.0 以降がローカルマシンにインストールされていることを確認します。

サンプルリポジトリの作成

既存のリポジトリを使用するには、サンプル記述子ファイルを作成するに進んでください。サンプルリポジトリとして使用する新しいリポジトリを作成するには、次の手順に従います。

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

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

サンプルディレクトリには、任意の情報を含めることができ、リポジトリ内の任意の場所に配置できます。この例では、2 つのサンプルディレクトリ「hello-world」と「kubernetes-custom-sample」が「custom-sample-repo」に追加されました。

カスタムサンプルの使用方法が解説されている readme ファイルを使用することを強くおすすめします。

サンプル記述子ファイルを作成する。

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

サンプル記述子スキーマ

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

例

{
   "metadata":{
      "version":"1"
   },
   "name": "My Sample Repository",
   "templates":[
      {
         "path":"/path/to/sample1_location",
         "name":"My Sample 1",
         "description":"The first sample of its name."
      },
      {
         "path":"/path/to/sample2_location",
         "name":"My Sample 2",
         "description":"The sequel."
      }
   ]
}

サンプルスキーマ

鍵	説明	型
パス	リポジトリ内のサンプルの場所。このパスは、リポジトリのルートからの相対パスです。	String（文字列）
名前	サンプルの名前。この名前は、アプリケーションのベースとなるサンプルを選択するときに IDE に表示されます。	String（文字列）
説明（省略可）	サンプルの説明。この説明はアプリケーションのベースとなるサンプルを選択するときに IDE に表示されます。	String（文字列）

例

{
   "path":"path/to/sample1",
   "name":"My Sample 1",
   "description":"The first sample of its name."
}

メタデータスキーマ

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

例

{
   "version":"1"
}

カスタムサンプルリポジトリの削除

カスタムサンプルを削除するには、カスタムアプリケーションセレクタのフローとユーザーのマシンからサンプルを削除します。

settings.json ファイルで、カスタムサンプルエントリの localPath を検索します。

"cloudcode.customApplications": [
  {
    "repoUrl": https://github.com/GoogleCloudPlatform/cloud-code-custom-samples-example.git,
    "branchName": "",
    "localPath": "/Users/username/Library/cloud-code/custom-templates/https-github-com-google-cloud-platform-cloud-code-custom-samples-example-git"
  }
],

そのパスにあるテンプレートフォルダを削除します。
注: Mac の Library は、非表示のフォルダです。
settings.json ファイルからカスタムサンプルセクションを削除します。

サポートを利用する

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

Cloud Code for VS Code でカスタム サンプル リポジトリを管理する

始める前に

サンプル リポジトリの作成