Benutzerdefinierte Beispiel-Repositories in Cloud Code for VS Code verwalten

Ein Beispiel-Repository ist ein Git-Repository, das benutzerdefinierte Beispiele enthält, die Sie erstellen und die Ihr Team zur Entwicklung 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. Dies trägt dazu bei, neue Projekte an den bevorzugten technischen Stack und die Standards Ihrer Organisation anzupassen und Best Practices zu Beginn des Entwicklungszyklus zu fördern.

Ein Beispiel-Repository kann ein vorhandenes Repository mit Beispielanwendungen sein die du bereits erstellt hast, oder einen neuen Satz Beispiele, den du verwenden möchtest. Um ein Repository mit Cloud Code zu importieren, fügen Sie ein Beispiel-Deskriptordatei in das Repository.

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.

Hinweise

Auf Ihrem lokalen Computer muss Git-Version 2.25.0 oder höher installiert sein.

Beispiel-Repository erstellen

Wenn Sie ein vorhandenes Repository verwenden möchten, fahren Sie mit Beispieldeskriptordatei erstellen So erstellen Sie ein neues für das Beispiel-Repository verwenden möchten, führen Sie die folgenden Schritte aus:

  1. Erstellen Sie ein neues Git-Repository.

    Ihr Git-Repository kann remote oder live bei Ihnen gehostet werden Maschine. 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 beliebige Inhalte enthalten und sich an einem beliebigen Ort befinden, im Repository enthalten sein soll. 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 Beispiel-Deskriptordatei.

    Eine Beispiel-Deskriptordatei liefert Informationen um Ihre Anwendung ordnungsgemäß zu erstellen. Diese Datei muss den Namen .cctemplate haben und sich im Stammverzeichnis befinden. Das Schema muss im Abschnitt Schema einer Beispiel-Deskriptordatei definiert sein.

  4. Testen Sie Ihre benutzerdefinierte Stichprobe, indem Sie die folgenden Schritte ausführen: Anwendung aus einem benutzerdefinierten Beispiel erstellen

Beispieldeskriptorschema

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 den Beispielschema. 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 der Stichprobe in einem Repository.
Der Pfad ist relativ zum Stammverzeichnis des Repositorys. 		String
name Name eines Beispiels.
Der Name wird in einer IDE angezeigt, wenn ein Beispiel als Basis für eine aktiviert haben. 		String
Beschreibung (optional) Beschreibung eines Beispiels.
Die Beschreibung wird in einer IDE angezeigt, wenn ein Beispiel als Basis für eine aktiviert haben. 		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 erhalten

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