Administra repositorios de muestras personalizados en Cloud Code para IntelliJ
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Un repositorio de muestra es un repositorio de Git que contiene muestras personalizadas que creaste para que tu equipo use a fin de desarrollar aplicaciones.
Esto significa que, dentro de una organización o equipo, puedes configurar repositorios de muestra con Cloud Code, personalizado para tu organización, para ofrecer un conjunto estándar de aplicaciones de inicio, servicios y configuración de infraestructura que otros pueden usar. Esto ayuda a alinear los proyectos nuevos con la pila técnica y los estándares preferidos de la organización, y fomenta las prácticas recomendadas al comienzo del ciclo de desarrollo.
Un repositorio de muestra puede ser un repositorio existente de aplicaciones de ejemplo que ya creaste o un conjunto nuevo de muestras que deseas que usen otras personas.
Para importar un repositorio con Cloud Code, debes agregar un archivo descriptor de muestra al repositorio.
Cuando estén listos, los repositorios de muestra son fáciles de compartir con tu equipo. Deberán configurar Cloud Code y la URL de Git del repositorio de muestra que se usará. Para los repositorios de Git privados, solo los miembros que tienen acceso al repositorio pueden usar las muestras personalizadas subyacentes.
Para ver un ejemplo de cómo se podría configurar un repositorio de muestra, consulta este repositorio.
Antes de comenzar
Asegúrate de que la versión 2.25.0 o posterior de Git esté instalada en tu máquina local.
Crea un repositorio de muestra
Para usar un repositorio existente, ve a cómo crear un archivo descriptor de muestra. Para crear un repositorio nuevo que se usará como repositorio de muestra, sigue estos pasos:
Crea un repositorio de Git nuevo.
Tu repositorio de Git se puede alojar de forma remota o en vivo en tu máquina local. En este ejemplo, se usa un repositorio de GitHub nuevo, “custom-sample-repo”.
Agrega directorios de muestra al repositorio.
Los directorios de muestra pueden contener todo y ubicarse en cualquier lugar que desees dentro del repositorio. En este ejemplo, se agregaron dos directorios de muestra, “hello-world” y “kubernetes-custom-sample”, a “custom-sample-repo”.
Se recomienda un archivo readme con instrucciones para usar mejor tus muestras personalizadas.
Array de muestras incluidas en un repositorio.
Los objetos de este array deben cumplir con el esquema de muestra.
Array<Sample>
Nombre (opcional)
Nombre del repositorio de muestra.
String
Ejemplo
{
"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."
}
]
}
Esquema de muestra
Clave
Descripción
Tipo
ruta
Ubicación de la muestra en un repositorio.
La ruta de acceso es relativa a la raíz del repositorio.
String
nombre
Nombre de una muestra.
El nombre se muestra en un IDE cuando se selecciona una muestra en la que se basará una
aplicación.
String
descripción (opcional)
Descripción de una muestra.
La descripción se muestra en un IDE cuando se selecciona una muestra en la que se basará una
aplicación.
String
Ejemplo
{
"path":"path/to/sample1",
"name":"My Sample 1",
"description":"The first sample of its name."
}
Esquema de metadatos
Clave
Descripción
Tipo
version
Es la versión del esquema de muestra que se usará. La única versión válida es
1.
String
Ejemplo
{
"version":"1"
}
Borra un repositorio de muestra personalizado
Para borrar una muestra personalizada, que la quita del flujo de selección de la aplicación personalizada y de las máquinas de los usuarios, haz lo siguiente:
En el archivo settings.json, busca el localPath para la entrada de muestra personalizada.
En la tabla Custom Sample Repositories, selecciona la URL del repositorio que deseas quitar y haz clic en - Remove.
En el cuadro de diálogo de confirmación que aparece, haz clic en Quitar para borrar el repositorio seleccionado de Cloud Code.
Obtenga asistencia
Para enviar comentarios o informar un problema en tu IDE de IntelliJ, ve a Tools > Cloud Code > Help / About > Submit feedback or report an issue para informar un problema en GitHub.
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 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)."]]
