Benutzerdefinierte Beispiel-Repositories in Cloud Code for VS Code verwalten

Ein Beispiel-Repository ist ein Git-Repository, das benutzerdefinierte Beispiele enthält, die Ihr Team zum Entwickeln von Anwendungen verwenden kann.

Das bedeutet, dass Sie innerhalb einer Organisation oder eines Teams Beispiel-Repositories mit Cloud Code erstellen können, die speziell auf Ihre Organisation zugeschnitten sind, um eine Reihe von Startanwendungen, -diensten und -infrastrukturkonfiguration zur Verfügung zu stellen, die von anderen genutzt werden können. So können neue Projekte gemäß dem bevorzugten technischen Stack und den Standards Ihrer Organisation ausgerichtet werden. Außerdem werden zu Beginn des Entwicklungszyklus Best Practices empfohlen.

Ein Beispiel-Repository kann ein vorhandenes Repository mit Beispielanwendungen sein, die Sie bereits erstellt haben, oder eine neue Gruppe von Stichproben, die andere verwenden sollen. Wenn Sie ein Repository mit Cloud Code importieren möchten, fügen Sie dem Repository eine Beispiel-Deskriptordatei hinzu.

Wenn sie fertig sind, können Sie die Beispiel-Repositories ganz einfach für Ihr Team freigeben. Dazu müssen Sie Cloud Code einrichten und die Git-URL des zu verwendenden Beispiel-Repositories angeben. Bei privaten Git-Repositories können nur Mitglieder, die Zugriff auf das Repository haben, die zugrunde liegenden benutzerdefinierten Beispiele verwenden.

Ein Beispiel für das Einrichten eines Beispiel-Repositorys finden Sie in diesem Repository.

Hinweis

Achten Sie darauf, dass Git-Version 2.25.0 oder höher auf Ihrem lokalen Computer installiert ist.

Beispiel-Repository erstellen

Wenn Sie ein vorhandenes Repository verwenden möchten, fahren Sie mit dem Erstellen einer Beispieldeskriptordatei fort. So erstellen Sie ein neues Repository als Beispiel-Repository:

  1. Erstellen Sie ein neues Git-Repository.

    Ihr Git-Repository kann remote oder auf Ihrem lokalen Computer gehostet werden. In diesem Beispiel wird das neue GitHub-Repository „custom-sample-repo“ verwendet.

    GitHub-Repository-Erstellungsoberfläche mit Feld „Repository-Name“, das mit „custom-sample-repo“ gefüllt wurde

  2. Fügen Sie dem Repository Beispielverzeichnisse hinzu.

    Ihre Beispielverzeichnisse können alles enthalten und befinden sich an einem beliebigen Ort im Repository. In diesem Beispiel wurden dem Verzeichnis „custom-sample-repo“ die beiden Beispielverzeichnisse „hello-world“ und „kubernetes-custom-sample“ hinzugefügt.

    Eine Readme-Datei mit Anweisungen zur optimalen Verwendung Ihrer benutzerdefinierten Beispiele wird dringend empfohlen.

    „custom-sample-repo“ mit zwei zugrunde liegenden Beispielverzeichnissen: „hello-world“ und „kubernetes-custom-sample“

  3. Erstellen Sie eine Beispieldeskriptordatei.

    Eine Beispiel-Deskriptordatei enthält Cloud Code mit Informationen zu Ihrem Beispiel, um Ihre Anwendung ordnungsgemäß erstellen zu können. Diese Datei muss .cctemplate heißen, muss sich in Ihrem Stammverzeichnis befinden und das Schema muss im Abschnitt Beispielschema für Datei mit Beschreibungen definiert sein.

  4. Testen Sie das benutzerdefinierte Beispiel. Folgen Sie dazu den Schritten zum Erstellen einer Anwendung aus einem benutzerdefinierten Beispiel.

Beispiel für ein Deskriptorschema

Schlüssel Beschreibung Typ
metadata Von Cloud Code zum Lesen verwendete Metadaten. Entspricht dem Metadatenschema. Metadaten
Vorlagen Array von Beispielen in einem Repository. Objekte in diesem Array müssen dem Beispielschema entsprechen. Array<Beispiel>
Name (optional) Name des Beispiel-Repositorys. String

Beispiel

{
   "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."
      }
   ]
}

Beispielschema

Schlüssel Beschreibung Typ
Pfad Der Speicherort des Beispiels in einem Repository.
Der Pfad ist relativ zum Stammverzeichnis des Repositorys. 		String
name Name eines Beispiels.
Der Name wird in einer IDE angezeigt, wenn Sie ein Beispiel für die Auswahl einer Anwendung auswählen. 		String
Beschreibung (optional) Beschreibung eines Beispiels.
Die Beschreibung wird in einer IDE angezeigt, wenn Sie ein Beispiel für die Auswahl einer Anwendung auswählen. 		String

Beispiel

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

Metadaten-Schema

Schlüssel Beschreibung Typ
version Die Version des Beispielschemas, das verwendet werden soll. Die einzige gültige Version ist 1. String

Beispiel

{
   "version":"1"
}

Benutzerdefiniertes Beispiel-Repository löschen

So löschen Sie ein benutzerdefiniertes Beispiel, wodurch es aus dem Fluss des benutzerdefinierten Anwendungsselektors und von den Computern der Nutzer entfernt wird:

  1. Suchen Sie in der Datei settings.json nach localPath für den benutzerdefinierten Beispieleintrag.

    "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. Löschen Sie den Vorlagenordner im Pfad.

  3. Löschen Sie den benutzerdefinierten Beispielabschnitt aus der Datei settings.json.

Support anfragen

Wenn Sie Feedback senden möchten, können Sie Probleme auf GitHub melden oder eine Frage in Stack Overflow stellen.