Benutzerdefinierte Beispiel-Repositories in Cloud Code für Cloud Shell verwalten
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
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 Sie bereits erstellt haben, oder eine Reihe neuer Beispiele, die andere verwenden sollen.
Wenn Sie ein Repository mit Cloud Code importieren möchten, fügen Sie dem Repository eine Sample-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.
Beispiel-Repository erstellen
Wenn Sie ein vorhandenes Repository verwenden möchten, fahren Sie mit Erstellen einer Beispiel-Deskriptordatei fort. So erstellen Sie ein neues Repository, das als Beispiel-Repository verwendet werden soll:
Erstellen Sie ein neues Git-Repository.
Ihr Git-Repository kann entweder aus der Ferne oder auf Ihrem lokalen Computer gehostet werden. In diesem Beispiel wird das neue GitHub-Repository „custom-sample-repo“ verwendet.
Fügen Sie dem Repository Beispielverzeichnisse hinzu.
Ihre Beispielverzeichnisse können beliebige Elemente enthalten und sich an einer beliebigen Stelle 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.
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 bezieht sich auf das Stammverzeichnis des Repositorys.
String
name
Name eines Beispiels.
Der Name wird in einer IDE angezeigt, wenn ein Beispiel ausgewählt wird, auf dem eine Anwendung basieren soll.
String
Beschreibung (optional)
Beschreibung eines Beispiels.
Die Beschreibung wird in einer IDE angezeigt, wenn ein Beispiel ausgewählt wird, auf dem eine Anwendung basieren soll.
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 zu verwendenden Beispielschemas. 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:
Suchen Sie in der Datei settings.json nach localPath für den benutzerdefinierten Beispieleintrag.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-08-11 (UTC)."],[[["\u003cp\u003eSample repositories are Git repositories containing custom samples that teams can use to develop applications, aligning new projects with an organization's technical standards.\u003c/p\u003e\n"],["\u003cp\u003eThese repositories can be existing collections of sample applications or new sets of samples, which are imported into Cloud Code by adding a \u003ccode\u003e.cctemplate\u003c/code\u003e sample descriptor file to the root directory of the repository.\u003c/p\u003e\n"],["\u003cp\u003eTo create a new sample repository, one must create a Git repository, add sample directories, and then create the sample descriptor file, and there is a specific schema that this file must adhere to.\u003c/p\u003e\n"],["\u003cp\u003eSharing sample repositories with a team requires them to have Cloud Code set up and access to the Git URL, with private repositories restricted to members who have been granted permissions.\u003c/p\u003e\n"],["\u003cp\u003eDeleting a custom sample repository involves removing the template folder at the \u003ccode\u003elocalPath\u003c/code\u003e location, which can be found in the \u003ccode\u003esettings.json\u003c/code\u003e file, as well as deleting the corresponding entry in that same file.\u003c/p\u003e\n"]]],[],null,["# Manage custom sample repositories in Cloud Code for Cloud Shell\n\nA sample repository is a Git repository that contains custom samples you\ncreate that your team can use to develop applications.\n\nThis means that, within an organization or team, you can set up sample\nrepositories with Cloud Code, custom to your organization, to offer a\nstandard set of starter applications, services, and infrastructure configuration\nthat others can use. This helps align new projects with your organization's\npreferred technical stack and standards, and encourages best practices at the\nbeginning of the development cycle.\n\nA sample repository can be an existing repository of sample applications\nyou've already created or a new set of samples you'd like others to use.\nTo import a repository with Cloud Code, you add a\n[sample descriptor file](#sample_descriptor_schema) to the repository.\n\nWhen ready, sample repositories are easy to share with your team; they'll\nneed Cloud Code set up and the Git URL of the sample repository\nto use. For private Git repositories, only members that have access to the\nrepository can use the underlying custom samples.\n\nTo see an example of how a sample repository might be set up, reference this\n[repository](https://github.com/GoogleCloudPlatform/cloud-code-custom-samples-example/).\n\nCreating a sample repository\n----------------------------\n\nTo use an existing repository, skip to\n[creating a sample descriptor file](#sample_descriptor). To create a new\nrepository to use as a sample repository, follow these steps:\n\n1. Create a new Git repository.\n\n Your Git repository can be hosted remotely or live on your local\n machine. This example uses a new GitHub repository, 'custom-sample-repo'.\n\n2. Add sample directories to the repository.\n\n Your sample directories can contain anything and be located anywhere you\n want in the repository. In this example, two sample directories,\n 'hello-world' and 'kubernetes-custom-sample', have been added\n to 'custom-sample-repo'.\n\n A readme file with instructions on how best to use your custom samples\n is highly recommended.\n\n\n3. Create a sample descriptor file.\n\n A sample descriptor file provides Cloud Code with information\n on your sample to properly create your application. This file must be named\n `.cctemplate`, must be located in your root directory, and must have the\n schema defined in the\n [sample descriptor file schema](#sample_descriptor_schema) section.\n4. Test your custom sample by following the steps to\n [create an app from a custom sample](/code/docs/shell/create-app-from-custom-sample).\n\nSample descriptor schema\n------------------------\n\n#### Example\n\n {\n \"metadata\":{\n \"version\":\"1\"\n },\n \"name\": \"My Sample Repository\",\n \"templates\":[\n {\n \"path\":\"/path/to/sample1_location\",\n \"name\":\"My Sample 1\",\n \"description\":\"The first sample of its name.\"\n },\n {\n \"path\":\"/path/to/sample2_location\",\n \"name\":\"My Sample 2\",\n \"description\":\"The sequel.\"\n }\n ]\n }\n\n### Sample schema\n\n#### Example\n\n {\n \"path\":\"path/to/sample1\",\n \"name\":\"My Sample 1\",\n \"description\":\"The first sample of its name.\"\n }\n\n### Metadata schema\n\n#### Example\n\n {\n \"version\":\"1\"\n }\n\nDeleting a custom sample repository\n-----------------------------------\n\nTo delete a custom sample, which removes it from the custom application\nselector flow and from users' machines:\n\n1. In the `settings.json` file, look up the `localPath` for the custom sample\n entry.\n\n \"cloudcode.customApplications\": [\n {\n \"repoUrl\": https://github.com/GoogleCloudPlatform/cloud-code-custom-samples-example.git,\n \"branchName\": \"\",\n \"localPath\": \"/Users/username/Library/cloud-code/custom-templates/https-github-com-google-cloud-platform-cloud-code-custom-samples-example-git\"\n }\n ],\n\n2. Delete the template folder at the path.\n\n | **Note:** On Macs, `Library` is a hidden folder.\n3. Delete the custom sample section from the `settings.json` file."]]
