Beispiel-Repository einrichten

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

Das bedeutet, dass Sie innerhalb einer Organisation oder eines Teams Beispiel-Repositories mit Cloud Code benutzerdefiniert einrichten können, die auf Ihre Organisation zugeschnitten sind und Standard-Startanwendungen, -Dienste und -Infrastrukturkonfigurationen anbieten, die von anderen verwenden kann. Dies hilft, neue Projekte mit dem bevorzugten technischen Stack und den bevorzugten Standards Ihrer Organisation abzustimmen, und fördert die Implementierung von Best Practices am Anfang des Entwicklungszyklus.

Ein Beispiel-Repository kann ein vorhandenes Repository von Beispielanwendungen sein, die Sie bereits erstellt haben, oder ein komplett neuer Satz von Beispielen, den andere verwenden sollen. Sie müssen dem Repository nur eine Beispieldeskriptor-Datei hinzufügen, um sie mit Cloud Code zu importieren.

Wenn Sie fertig sind, können Sie Beispiel-Repositories einfach für Ihr Team freigeben Sie benötigen Cloud Code eingerichtet und die Git-URL des zu verwendenden Beispiel-Repositorys. Bei privaten Git-Repositories können nur Mitglieder mit Zugriff auf das Repository die zugrunde liegenden benutzerdefinierten Beispiele verwenden.

Ein Beispiel für die Einrichtung eines Beispiel-Repositorys finden Sie in diesem Repository.

Neues Beispiel-Repository erstellen

Wenn Sie ein neues Beispiel-Repository zur Verwendung erstellen möchten, gehen Sie so vor:

  1. Erstellen Sie ein neues Git-Repository.

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

    Die Schnittstelle zum Erstellen von GitHub-Repositories, in der das Feld für den Repository-Namen mit customcustom-sample-repo“ gefüllt ist

  2. Fügen Sie Beispielverzeichnisse zu diesem Repository hinzu.

    Ihre Beispielverzeichnisse können beliebige Elemente enthalten und sich an einer beliebigen Stelle innerhalb des Repositorys befinden. In diesem Beispiel wurden dem Verzeichnis customcustom-sample-repo“ die beiden Beispielverzeichnisse hellohello-world“ und kuberneteskubernetes-custom-sample“ hinzugefügt.

    Eine Readme-Datei mit einer Anleitung zur Verwendung Ihrer benutzerdefinierten Beispiele wird dringend empfohlen.

    customcustom-sample-repo“ mit den beiden zugrunde liegenden Beispielverzeichnissen 'hello-world“ und kuberneteskubernetes-custom-sample“

  3. Erstellen Sie eine Beispieldeskriptor-Datei.

    Eine Beispieldeskriptor-Datei stellt Cloud Code mit Informationen zu Ihrem Beispiel bereit, damit die Anwendung ordnungsgemäß erstellt werden kann. Diese Datei muss den Namen .cctemplate im Stammverzeichnis haben und das Schema im Abschnitt Schemaschema-Dateischema definiert haben.

Vorhandenes Repository verwenden

Wenn Sie ein vorhandenes Repository verwenden möchten, müssen Sie dennoch eine Beispieldeskriptor-Datei erstellen. Diese Datei enthält Cloud Code mit Informationen zu Ihrem Beispiel, um Ihre Anwendung ordnungsgemäß zu erstellen.

Die Beispieldeskriptordatei muss .cctemplate benannt sein, sich in Ihrem Stammverzeichnis befinden und das Schema im Abschnitt Schemaschemadatei definieren.

Beispiel für ein Deskriptorschema

Key Beschreibung Typ
metadata Metadaten, die von Cloud Code zum Lesen verwendet werden. Entspricht dem Metadatenschema. Metadaten
Vorlagen Array von Stichproben, die in einem Repository enthalten sind Objekte in diesem Array sollten 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

Key Beschreibung Typ
Pfad Wo sich das Beispiel in einem Repository befindet.

Der Pfad wird so interpretiert, als stammt er vom Stammverzeichnis des Repositorys.

String
name Name einer Stichprobe.

Diese ID wird in einer IDE angezeigt, wenn Sie ein Beispiel als Basis für eine Anwendung auswählen.

String
Beschreibung (optional) Beschreibung eines Beispiels.

Diese ID wird in einer IDE angezeigt, wenn Sie ein Beispiel als Basis für eine Anwendung auswählen.

String

Beispiel

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

Metadatenschema

Key Beschreibung Typ
version Die Version des verwendeten Beispielschemas. Die einzige gültige Version ist derzeit 1. String

Beispiel

{
   "version":"1"
}

Support

Wenn Sie Feedback geben oder ein Problem in Ihrer IntelliJ-IDE melden möchten, gehen Sie zu Tools > Cloud Code > Help / About > . Senden Sie Feedback oder melden Sie ein Problem, um ein Problem auf GitHub zu melden, oder stellen Sie eine Frage in Stack Overflow.

Sie können auch dem Kanal #cloud-code beitreten, der Teil der Google Cloud-Slack-Community ist.