Benutzerdefinierte Beispiel-Repositories in Cloud Code für VS Code verwalten

Ein Beispiel-Repository ist ein Git-Repository mit benutzerdefinierten Beispielen, die Sie von Ihrem Team zum Entwickeln von Anwendungen verwenden können.

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 lassen sich neue Projekte besser auf den bevorzugten technischen Stack und die Standards Ihres Unternehmens abstimmen. 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 Beispielen, die andere verwenden sollen. Wenn Sie ein Repository mit Cloud Code importieren möchten, fügen Sie dem Repository eine Beispieldatei 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

Prüfen Sie, ob 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 gehostet werden oder auf Ihrem lokalen Rechner live sein. In diesem Beispiel wird ein neues 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 im Repository befinden. 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 Beispieldeskriptor-Datei.

    Eine Beispieldeskriptor-Datei stellt Cloud Code Informationen zur Verfügung, mit denen Sie Ihre Anwendung richtig erstellen können. Diese Datei muss den Namen .cctemplate haben, muss sich in deinem Stammverzeichnis befinden und das Schema haben, das im Abschnitt Schema für Beschreibungen des Dateideskriptors definiert wurde.

  4. Testen Sie Ihr benutzerdefiniertes Beispiel so, dass Sie eine Anwendung aus einem benutzerdefinierten Beispiel erstellen.

Beispiel für ein Deskriptor-Schema

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 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 Sie ein Beispiel für die Ausführung einer Anwendung auswählen.
String
Beschreibung (optional) Beschreibung eines Beispiels.
Die Beschreibung wird in einer IDE angezeigt, wenn Sie ein Beispiel für die Ausführung 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

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