Gérer des exemples de dépôts personnalisés dans Cloud Code pour IntelliJ

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 votre pile technique et vos normes préférées, et encourage les bonnes pratiques au début du cycle de développement.

Un exemple de dépôt peut être un dépôt existant d'exemples d'applications que vous avez déjà créés ou un ensemble d'échantillons que vous souhaitez que d'autres personnes utilisent. Pour importer un dépôt avec Cloud Code, vous devez ajouter un exemple de fichier descripteur 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ée sur votre ordinateur local.

Créer un exemple de dépôt

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

  1. Créer 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".

    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. Ajouter des répertoires d'exemples au dépôt.

    Vos exemples de répertoires peuvent contenir n'importe quel élément et se trouver à l'emplacement de votre choix 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, être situé dans votre répertoire racine et utiliser le schéma défini dans la section Schéma de fichier descripteur d'exemple.

  4. Testez votre exemple personnalisé en suivant la procédure ci-dessous : Créer une application à partir d'un exemple personnalisé

Schéma de descripteur d'exemple

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'exemple 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 la valeur localPath de l'entrée d'exemple 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 de l'échantillon personnalisé du fichier settings.json.

Supprimer un dépôt d'exemples personnalisé

Pour supprimer un exemple de dépôt personnalisé de Cloud Code, procédez comme suit:

  1. Accédez à Préférences > Outils > Cloud Code > Exemples personnalisés.

  2. Dans le tableau Dépôts d'exemples personnalisés, sélectionnez l'URL de dépôt à supprimer, puis cliquez sur - Supprimer.

    Boîte de dialogue de suppression du dépôt dans IntelliJ

  3. Dans la boîte de dialogue de confirmation qui s'affiche, cliquez sur Supprimer pour supprimer le du dépôt sélectionné dans 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, ou posez une question sur Stack Overflow.