Gérer des dépôts d'exemples personnalisés dans Cloud Code for IntelliJ
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Un dépôt d'exemples est un dépôt Git contenant des exemples personnalisés que vous avez créés pour aider votre équipe à développer des applications.
Cela signifie, au sein d'une organisation ou d'une équipe, que vous pouvez configurer des dépôt d'exemples avec Cloud Code et les personnaliser pour votre organisation afin de proposer un ensemble standard d'applications de démarrage, de services et de configuration d'infrastructure que d'autres peuvent utiliser. Cela permet d'aligner les nouveaux projets sur les piles et les normes techniques préférées de votre organisation, et d'intégrer les bonnes pratiques au début du cycle de développement.
Un dépôt d'exemples peut être un dépôt d'exemples d'applications que vous avez déjà créé ou un nouvel ensemble d'exemples que vous souhaitez que d'autres utilisent.
Pour importer un dépôt avec Cloud Code, ajoutez un fichier descripteur d'exemple au dépôt.
Une fois prêt, le dépôt d'exemples peut être partagé facilement avec votre équipe. Il suffit que les membres installent Cloud Code et accèdent à l'URL Git correspondant pour l'utiliser. Pour les dépôts Git privés, seuls les membres ayant accès au dépôt peuvent utiliser les exemples personnalisés sous-jacents.
Pour savoir comment configurer un dépôt d'exemples, consultez ce dépôt.
Avant de commencer
Assurez-vous que Git version 2.25.0 ou ultérieure est installé sur votre ordinateur local.
Créer un dépôt d'exemples
Pour utiliser un dépôt existant, passez à la section Créer un fichier descripteur d'exemple. Pour créer un dépôt à utiliser comme dépôt d'exemples, procédez comme suit :
Créez un dépôt Git.
Votre dépôt Git peut être hébergé à distance ou directement sur votre ordinateur local. Cet exemple utilise un nouveau dépôt GitHub, "custom-sample-repo".
Ajoutez des répertoires d'exemples au dépôt.
Vos répertoires d'exemples peuvent contenir n'importe quel élément et être situés n'importe où dans le dépôt. Dans le cas présent, deux répertoires d'exemples ("hello-world" et "kubernetes-custom-sample") ont été ajoutés à "custom-sample-repo".
Nous vous recommandons vivement d'utiliser un fichier "readme" contenant des instructions sur la meilleure façon d'utiliser vos exemples personnalisés.
Métadonnées utilisées par Cloud Code pour la lecture.
Respecte le schéma de métadonnées.
Métadonnées
Modèles
Tableau des exemples contenus dans un dépôt.
Les objets de ce tableau doivent être conformes au schéma d'exemple.
Tableau<Exemple>
Nom (facultatif)
Nom du dépôt d'exemples.
Chaîne
Exemple
{
"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."
}
]
}
Schéma d'exemple
Clé
Description
Type
chemin d'accès
Emplacement de l'échantillon dans un dépôt.
Le chemin d'accès est relatif à la racine du dépôt.
Chaîne
nom
Nom d'un exemple.
Le nom s'affiche dans un IDE lors de la sélection d'un exemple sur lequel baser une
application.
Chaîne
Description (facultatif)
Description d'un exemple.
La description s'affiche dans un IDE lors de la sélection d'un exemple sur lequel baser une application.
Chaîne
Exemple
{
"path":"path/to/sample1",
"name":"My Sample 1",
"description":"The first sample of its name."
}
Schéma de métadonnées
Clé
Description
Type
version
Version du schéma d'exemple à utiliser. La seule version valide est 1.
Chaîne
Exemple
{
"version":"1"
}
Supprimer un dépôt d'exemples personnalisé
Pour supprimer un exemple personnalisé, afin de le supprimer du flux du sélecteur d'application personnalisé et des machines des utilisateurs, procédez comme suit :
Dans le fichier settings.json, recherchez la valeur localPath de l'entrée d'exemple personnalisé.
Dans le tableau Dépôts d'exemples personnalisés, sélectionnez l'URL du dépôt que vous souhaitez supprimer, puis cliquez sur - Supprimer.
Dans la boîte de dialogue de confirmation qui s'affiche, cliquez sur Supprimer pour supprimer le dépôt sélectionné de Cloud Code.
Obtenir de l'aide
Pour envoyer des commentaires ou signaler un problème dans votre IDE IntelliJ, accédez à Outils > Cloud Code > Aide / À propos > Envoyer des commentaires ou signaler un problème pour signaler un problème sur GitHub.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/05 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/09/05 (UTC)."],[[["\u003cp\u003eA sample repository in Cloud Code contains custom samples for teams to use in developing applications, promoting standardized starter configurations.\u003c/p\u003e\n"],["\u003cp\u003eSample repositories can be existing or newly created Git repositories, requiring a \u003ccode\u003e.cctemplate\u003c/code\u003e descriptor file in the root directory for Cloud Code to recognize them.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003e.cctemplate\u003c/code\u003e file defines metadata and an array of samples, each with details like path, name, and an optional description, enabling Cloud Code to understand and use each custom template.\u003c/p\u003e\n"],["\u003cp\u003eTo share sample repositories, users need Cloud Code and the repository's Git URL, and access to private repositories is limited to authorized members only.\u003c/p\u003e\n"],["\u003cp\u003eCustom sample repositories can be removed from Cloud Code either by manually deleting them or by navigating through the \u003cstrong\u003ePreferences\u003c/strong\u003e to remove the desired repository.\u003c/p\u003e\n"]]],[],null,["# Manage custom sample repositories in Cloud Code for IntelliJ\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\nBefore you begin\n----------------\n\nMake sure that Git version 2.25.0 or later is installed on your local\nmachine.\n\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/intellij/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.\n\nDeleting a custom sample repository\n-----------------------------------\n\nTo delete a custom sample repository from Cloud Code:\n\n1. Navigate to **Preferences** \\\u003e **Tools** \\\u003e **Cloud Code** \\\u003e\n **Custom Samples**.\n\n2. In the **Custom Sample Repositories** table, select the repository URL that\n you want to remove and click **- Remove**.\n\n3. In the confirmation dialog that appears, click **Remove** to delete the\n selected repository from Cloud Code.\n\nGet support\n-----------\n\nTo submit feedback or report an issue in your IntelliJ IDE, go to **Tools** \\\u003e **Cloud Code** \\\u003e **Help / About** \\\u003e **Submit\nfeedback or report an issue** to report an issue on [GitHub](https://github.com/GoogleCloudPlatform/cloud-code-intellij/issues)."]]
