カスタム サンプル リポジトリの管理

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

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

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

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

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

始める前に

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

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

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

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

    Git リポジトリは、リモートまたはローカルマシンでホストできます。この例では、新しい GitHub リポジトリ「custom-sample-repo」を使用します。

    リポジトリ名が「custom-sample-repo」である GitHub リポジトリ作成インターフェース

  2. このリポジトリにサンプル ディレクトリを追加する。

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

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

    「hello-world」と「kubernetes-custom-sample」という 2 つの基本サンプル ディレクトリが存在する「custom-sample-repo」

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

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

  4. 次の手順を行ってカスタム サンプルをテストし、カスタム サンプルからアプリを作成します。

サンプル記述子スキーマ

説明
メタデータ 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"
}

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

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

  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"
      }
    ],
    
  2. そのパスにあるテンプレート フォルダを削除します。

  3. settings.json ファイルからカスタム サンプル セクションを削除します。

サポートの利用

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