Gérer des dépôts d'exemples personnalisés dans Cloud Code pour VS Code

Un dépôt d'exemples est un dépôt Git contenant des exemples personnalisés que vous créez et que votre équipe peut utiliser pour 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 la pile technologique et les normes préférées de votre organisation, et d'encourager les bonnes pratiques dès le début du cycle de développement.

Un dépôt d'exemples peut être un dépôt existant d'applications exemples que vous avez déjà créées ou un nouvel ensemble d'exemples que vous souhaitez que d'autres utilisateurs utilisent. Pour importer un dépôt avec Cloud Code, vous devez ajouter un fichier de description 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 la version 2.25.0 ou ultérieure de Git est installée sur votre ordinateur local.

Créer un exemple de dépôt

Pour utiliser un dépôt existant, passez à la section Créer un exemple de fichier descripteur. Pour créer un dépôt à utiliser comme dépôt d'exemple, procédez comme suit :

  1. Créez un dépôt Git.

    Votre dépôt Git peut être hébergé à distance ou se trouver sur votre machine locale. Cet exemple utilise un nouveau dépôt GitHub, "custom-sample-repo".

    Interface de création de dépôt GitHub avec la valeur "custom-sample-repo" renseignée dans le champ de nom du dépôt

  2. Ajoutez des répertoires d'exemples au dépôt.

    Vos répertoires d'exemples peuvent contenir n'importe quoi et se trouver 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.

    "custom-sample-repo" avec deux répertoires d'exemples sous-jacents, "hello-world" et "kubernetes-custom-sample"

  3. Créez un exemple de fichier descripteur.

    Un exemple de fichier descripteur fournit à Cloud Code des informations sur votre exemple pour créer correctement votre application. Ce fichier doit être nommé .cctemplate, doit se trouver dans votre répertoire racine et doit avoir le schéma défini dans la section Schéma de fichier descripteur d'exemple.

  4. Testez votre exemple personnalisé en suivant les étapes pour créer une application à partir d'un exemple personnalisé.

Exemple de schéma de descripteur

Clé Description Type
metadata Métadonnées utilisées par Cloud Code pour la lecture. Conforme au 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 lorsque vous sélectionnez un exemple sur lequel baser une application. 		Chaîne
Description (facultatif) Description d'un exemple.
La description s'affiche dans un IDE lorsque vous sélectionnez 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 :

  1. Dans le fichier settings.json, recherchez le localPath de l'entrée d'échantillon personnalisé.

    "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. Supprimez le dossier de modèle au niveau du chemin d'accès.

  3. Supprimez la section d'échantillon personnalisé du fichier settings.json.

Obtenir de l'aide

Pour envoyer des commentaires, posez une question sur Stack Overflow. Si vous êtes un client Google Cloud, vous pouvez envoyer des demandes via les canaux d'assistance Google Cloud standards.