Administra repositorios de muestra personalizados en Cloud Code para VS Code

Un repositorio de muestra es un repositorio de Git que contiene muestras personalizadas que creas y que tu equipo puede usar para 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 tu 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 muestra que ya creaste o un conjunto nuevo de muestras que desees que usen otras personas. Para importar un repositorio con Cloud Code, agrega 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 Git 2.25.0 o una versión posterior esté instalada en tu máquina local.

Crea un repositorio de muestra

Para usar un repositorio existente, ve a Crea un archivo descriptor de muestra. Si deseas crear un repositorio nuevo y usarlo como repositorio de muestra, sigue estos pasos:

  1. Crea un nuevo repositorio de Git.

    Tu repositorio de Git se puede alojar de forma remota o en tu máquina local. En este ejemplo, se usa un repositorio de GitHub nuevo llamado “custom-sample-repo”.

    Interfaz de creación de repositorio de GitHub con campo de nombre de repositorio completado con “custom-sample-repo”

  2. Agrega directorios de muestra al repositorio.

    Tus directorios de muestra pueden contener cualquier cosa y ubicarse en cualquier lugar del repositorio que desees. 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.

    “custom-sample-repo” con dos directorios de muestra subyacentes, “hello-world” y “kubernetes-custom-sample”

  3. Crea un archivo descriptor de muestra.

    Un archivo descriptor de muestra proporciona a Cloud Code información sobre tu muestra para crear adecuadamente tu aplicación. Este archivo se debe llamar .cctemplate, debe estar ubicado en tu directorio raíz y debe tener el esquema definido en la sección esquema de archivo descriptor de muestra.

  4. Prueba tu muestra personalizada siguiendo los pasos para crear una app a partir de una muestra personalizada.

Esquema descriptor de muestra

Clave Descripción Tipo
metadata Metadatos que usa Cloud Code para leer. Cumple con el esquema de metadatos. Metadata
Plantillas Array de muestras incluidas en un repositorio. Los objetos de este array deben cumplir con el Esquema de ejemplo. Array<Sample>
Nombre (opcional) Nombre del repositorio de muestra. Cadena

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 de acceso La ubicación de la muestra en un repositorio.
La ruta de acceso está relacionada con la raíz del repositorio. 		Cadena
name Nombre de una muestra.
El nombre se muestra en un IDE cuando se selecciona una muestra en la que basar una aplicación. 		Cadena
descripción (opcional) Descripción de una muestra.
La descripción se muestra en un IDE cuando se selecciona un ejemplo en el que se basa una aplicación. 		Cadena

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. Cadena

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:

  1. En el archivo settings.json, busca el localPath de la entrada de muestra personalizada.

    "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. Borra la carpeta de la plantilla en la ruta de acceso.

  3. Borra la sección de muestra personalizada del archivo settings.json.

Obtener asistencia

Si deseas enviar comentarios, informa problemas en GitHub o haz preguntas en Stack Overflow.