Commencer à utiliser des plans personnalisés

Au cours du processus de création d'un plan, vous pouvez configurer le plan et générer un aperçu des ressources du projet. Chaque plan personnalisé est géré par un CodeCatalyst projet, qui contient un flux de travail par défaut pour la publication dans le catalogue de plans de l'espace.

Lorsque vous configurez les détails de votre plan personnalisé, vous pouvez également choisir de stocker le code source de votre plan dans un référentiel tiers, où vous pouvez toujours gérer le plan personnalisé et utiliser les fonctionnalités de gestion du cycle de vie pour synchroniser les projets de votre espace lorsque le plan personnalisé est modifié. Pour plus d’informations, consultez Ajoutez des fonctionnalités aux projets avec des extensions dans CodeCatalyst et Travailler avec la gestion du cycle de vie en tant qu'auteur de plans.

Si vous disposez déjà d'un référentiel source normalisé et conforme aux meilleures pratiques, vous pouvez choisir de convertir ce référentiel source en un plan personnalisé. Pour plus d’informations, consultez Conversion des référentiels sources en plans personnalisés.

Prérequis

Avant de créer un plan personnalisé, tenez compte des exigences suivantes :

• Votre CodeCatalyst espace doit être de niveau Enterprise. Pour plus d'informations, consultez la section Gestion de la facturation dans le manuel Amazon CodeCatalyst Administrator Guide.

• Vous devez avoir le rôle d'administrateur de l'espace ou d'utilisateur avancé pour créer des plans personnalisés. Pour plus d’informations, consultez Octroi d'accès avec des rôles d'utilisateur.

Étape 1 : créer un plan personnalisé dans CodeCatalyst

Lorsque vous créez un plan personnalisé à partir des paramètres de votre espace, un référentiel est créé pour vous. Le référentiel inclut toutes les ressources nécessaires dont vous avez besoin pour développer votre plan avant de le publier dans le catalogue de plans de l'espace.

Pour créer un plan personnalisé

1. Ouvrez la CodeCatalyst console à l'adresse https://codecatalyst.aws/.

2. Dans la CodeCatalyst console, accédez à l'espace dans lequel vous souhaitez créer un plan personnalisé.

3. Sur le tableau de bord spatial, cliquez sur l'onglet Paramètres, puis sur Blueprints.

4. Choisissez Créer un plan.

5. Sous Nommer votre plan, entrez le nom que vous souhaitez attribuer à votre projet et les noms de ressources associés. Le nom doit être unique dans votre espace.

6. (Facultatif) Par défaut, le code source créé par le plan est stocké dans un CodeCatalyst référentiel. Vous pouvez également choisir de stocker le code source du plan dans un référentiel tiers. Pour plus d’informations, consultez Ajoutez des fonctionnalités aux projets avec des extensions dans CodeCatalyst.

   Procédez de l'une des manières suivantes en fonction du fournisseur de référentiel tiers que vous souhaitez utiliser :

   • GitHub référentiels : connectez un GitHub compte.

     Choisissez le menu déroulant Avancé, choisissez GitHub comme fournisseur de référentiel, puis choisissez le GitHub compte sur lequel vous souhaitez stocker le code source créé par le plan.

     Note

     Si vous utilisez une connexion à un GitHub compte, vous devez créer une connexion personnelle pour établir un mappage d'identité entre votre CodeCatalyst identité et votre GitHub identité. Pour plus d’informations, consultez Connexions personnelles et Accès aux GitHub ressources par le biais de connexions personnelles.

   • Référentiels Bitbucket : connectez un espace de travail Bitbucket.

     Choisissez le menu déroulant Avancé, choisissez Bitbucket comme fournisseur de référentiel, puis choisissez l'espace de travail Bitbucket dans lequel vous souhaitez stocker le code source créé par le plan.

   • GitLab référentiels : Connectez un GitLab utilisateur.

     Choisissez le menu déroulant Avancé, choisissez GitLab comme fournisseur de référentiel, puis choisissez l' GitLab utilisateur dans lequel vous souhaitez stocker le code source créé par le plan.

7. Sous Détails du plan, procédez comme suit :

   1. Dans le champ de saisie du nom d'affichage du plan, entrez un nom qui apparaîtra dans le catalogue des plans de votre espace.

   2. Dans le champ de saisie de texte Description, entrez une description pour votre plan personnalisé.

   3. Dans le champ de saisie du nom de l'auteur, entrez le nom de l'auteur pour votre plan personnalisé.

   4. (Facultatif) Choisissez les paramètres avancés.

      1. Choisissez + Ajouter pour ajouter des balises au package.json fichier.

      2. Choisissez le menu déroulant Licence, puis choisissez une licence pour votre plan personnalisé.

      3. Dans le champ de saisie du nom du package Blueprint, entrez un nom pour identifier votre package Blueprint.

      4. Par défaut, un flux de publication est généré à l'aide d'un plan de publication au sein de votre projet appelé Blueprint Builder. Le flux de travail publie la dernière version du plan dans votre espace lorsque vous apportez des modifications, car les autorisations de publication sont activées par le flux de travail de publication. Pour désactiver la génération du flux de travail, décochez la case Libérer le flux de travail.

8. (Facultatif) Un projet de plan est fourni avec un code prédéfini pour faciliter la publication du plan dans le catalogue de plans de l'espace. Pour afficher les fichiers de définition avec des mises à jour en fonction des paramètres de projet que vous avez sélectionnés, choisissez Afficher le code ou Afficher le flux de travail dans Générer un aperçu du plan.

9. Choisissez Créer un plan.

Si vous n'avez pas désactivé la génération de flux de travail pour votre plan personnalisé, le flux de travail commence automatiquement à s'exécuter lorsque votre plan est créé. Lorsque le flux de travail est terminé, votre plan personnalisé peut être ajouté par défaut au catalogue de plans de votre espace. Vous pouvez désactiver les autorisations de publication si vous ne souhaitez pas que la dernière version du plan soit publiée automatiquement dans votre espace. Pour plus d’informations, consultez Configuration des autorisations de publication pour un plan personnalisé et Exécution d'un flux de travail.

Étant donné que le flux de publication appelé blueprint-release est créé à l'aide d'un plan, celui-ci peut être trouvé sous forme de plan appliqué dans votre projet. Pour plus d’informations, consultez Ajouter un plan dans un projet pour intégrer des ressources et Dissocier un plan d'un projet pour arrêter les mises à jour.

Étape 2 : développer un plan personnalisé avec des composants

Un assistant de plan est généré lorsque vous créez un plan personnalisé, et il peut être modifié à l'aide de composants lors du développement du plan personnalisé. Vous pouvez mettre à jour les src/defaults.json fichiers src/blueprints.js et pour modifier l'assistant.

Important

Si vous souhaitez utiliser des packages de plans provenant de sources externes, prenez en compte les risques qui peuvent découler de ces packages. Vous êtes responsable des plans personnalisés que vous ajoutez à votre espace et du code qu'ils génèrent.

Créez un environnement de développement dans votre CodeCatalyst projet avec un environnement de développement intégré (IDE) pris en charge avant de configurer votre code de plan. Un environnement de développement est nécessaire pour travailler avec les outils et les packages requis.

Pour créer un environnement de développement

1. Dans le volet de navigation, effectuez l'une des opérations suivantes :

   1. Choisissez Overview, puis accédez à la section Mes environnements de développement.

   2. Choisissez Code, puis Dev Environments.

   3. Choisissez Code, choisissez Référentiels sources et choisissez le référentiel que vous avez créé lors de la création de votre plan.

2. Choisissez Create Dev Environment.

3. Choisissez un IDE compatible dans le menu déroulant. Voir Environnements de développement intégrés pris en charge pour les environnements de développement pour plus d'informations.

4. Choisissez Travailler dans une branche existante, puis dans le menu déroulant Branche existante, sélectionnez la branche de fonctionnalités que vous avez créée.

5. (Facultatif) Dans le champ Alias - saisie de texte facultatif, entrez un alias pour identifier l'environnement de développement.

6. Choisissez Créer. Pendant la création de votre environnement de développement, la colonne d'état de l'environnement de développement affiche Démarrage et la colonne d'état indique En cours d'exécution lorsque l'environnement de développement a été créé.

Pour plus d’informations, consultez Écrire et modifier du code avec les environnements de développement dans CodeCatalyst.

Pour développer votre plan personnalisé

1. Dans un terminal fonctionnel, utilisez la yarn commande suivante pour installer les dépendances :

   yarn

   Les outils et packages requis sont disponibles via l'environnement de CodeCatalyst développement, y compris Yarn. Si vous travaillez sur un plan personnalisé sans environnement de développement, installez d'abord Yarn sur votre système. Pour plus d'informations, consultez la documentation d'installation de Yarn.

2. Développez votre plan personnalisé afin qu'il soit configuré selon vos préférences. Vous pouvez modifier l'assistant de votre plan en ajoutant des composants. Pour plus d’informations, consultez Élaboration d'un plan personnalisé pour répondre aux exigences du projet, Modification des fonctionnalités du plan à l'aide d'un assistant frontal et Publication d'un plan personnalisé dans un espace.

Étape 3 : prévisualiser un plan personnalisé

Après avoir configuré et développé votre plan personnalisé, vous pouvez prévisualiser et publier la version d'aperçu de votre plan dans votre espace. Une version d'aperçu vous permet de vérifier que le plan correspond à vos attentes avant de l'utiliser pour créer de nouveaux projets ou de l'appliquer à des projets existants.

Pour prévisualiser un plan personnalisé

1. Dans un terminal en état de fonctionnement, utilisez la yarn commande suivante :

   yarn blueprint:preview

2. Accédez au See this blueprint at: lien fourni pour prévisualiser votre plan personnalisé.

3. Vérifiez que l'interface utilisateur, y compris le texte, s'affiche comme prévu en fonction de votre configuration. Si vous souhaitez modifier votre plan personnalisé, vous pouvez modifier le blueprint.ts fichier, resynthétiser le plan, puis publier à nouveau une version d'aperçu. Pour plus d’informations, consultez Resynthèse.

(Facultatif) Étape 4 : Publier une version d'aperçu du plan personnalisé

Vous pouvez publier une version préliminaire de votre plan personnalisé dans votre espace si vous souhaitez l'ajouter au catalogue de plans de votre espace. Cela vous permet de visualiser le plan en tant qu'utilisateur avant d'ajouter la version non prévisualisée au catalogue. La version d'aperçu vous permet de publier sans passer à une version réelle. Par exemple, si vous travaillez sur une 0.0.1 version, vous pouvez publier et ajouter une version d'aperçu, afin que les nouvelles mises à jour d'une deuxième version puissent être publiées et ajoutées en tant que0.0.2.

Pour publier une version d'aperçu d'un plan personnalisé

Accédez au Enable version [version number] at: lien fourni pour activer votre plan personnalisé. Ce lien est fourni lors de l'exécution de la yarn commandeÉtape 3 : prévisualiser un plan personnalisé.

Après avoir créé, développé, prévisualisé et publié votre plan personnalisé, vous pouvez publier et ajouter la version finale du plan au catalogue de plans de votre espace. Pour plus d'informations, consultez Publication d'un plan personnalisé dans un espace et Ajouter un plan personnalisé à un catalogue de plans spatiaux.