Publier un plan personnalisé dans un espace

Avant de pouvoir ajouter un plan personnalisé au catalogue de plans de votre espace, vous devez le publier dans l'espace. Vous pouvez également consulter le plan dans la CodeCatalyst console avant de le publier. Vous pouvez publier une version d'aperçu ou une version normale de votre plan.

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.

Important

Pour publier un plan personnalisé dans votre CodeCatalyst espace, vous devez être connecté avec un compte doté du rôle d'administrateur de l'espace ou d'utilisateur avancé dans l'espace.

Afficher et publier une version d'aperçu d'un 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.

Après avoir apporté des modifications, reconstruisez le package de votre plan personnalisé en exécutant le package.json fichier et prévisualisez vos modifications.

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

1. Reprenez votre environnement de développement. Pour plus d’informations, consultez Reprise d'un environnement de développement.

2. Ouvrez un terminal fonctionnel dans votre environnement de développement.

3. (Facultatif) Dans un terminal fonctionnel, installez les dépendances nécessaires à votre projet si vous ne les avez pas déjà installées. Utilisez la commande suivante :

   yarn

4. (Facultatif) Si vous avez apporté des modifications au .projenrc.ts fichier, régénérez la configuration de votre projet avant de créer et de prévisualiser votre plan. Utilisez la commande suivante :

   yarn projen

5. Reconstruisez et prévisualisez votre plan personnalisé à l'aide de la commande suivante. Utilisez la commande suivante :

   yarn blueprint:preview

   Accédez au See this blueprint at: lien fourni pour prévisualiser votre plan personnalisé. 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 de plus amples informations, veuillez consulter Resynthèse.

6. (Facultatif) Vous pouvez publier une version préliminaire de votre plan personnalisé, qui peut ensuite être ajoutée au catalogue de plans de votre espace. Accédez au Enable version [preview version number] at: lien pour publier une version préliminaire dans votre espace.

Vous pouvez émuler la création de projets sans avoir à en créer un dans CodeCatalyst. Pour synthétiser votre projet, utilisez la commande suivante :

yarn blueprint:synth

Un plan est généré dans le synth/synth.[options-name]/proposed-bundle/ dossier. Pour de plus amples informations, veuillez consulter Synthèse.

Si vous mettez à jour votre plan personnalisé, utilisez plutôt la commande suivante pour resynthétiser votre projet :

yarn blueprint:resynth

Un plan est généré dans le synth/synth.[options-name]/proposed-bundle/ dossier. Pour de plus amples informations, veuillez consulter Resynthèse.

Après avoir publié votre version d'aperçu, vous pouvez ajouter le plan afin que les membres de l'espace puissent l'utiliser pour créer de nouveaux projets ou ajouter des projets existants. Pour de plus amples informations, veuillez consulter Ajouter un plan personnalisé à un catalogue de plans spatiaux.

Afficher et publier une version normale d'un plan personnalisé

Une fois que vous avez terminé de développer et de prévisualiser votre plan personnalisé, vous pouvez consulter et publier la nouvelle version que vous souhaitez ajouter au catalogue de plans de votre espace. Le flux de publication généré lors de la création d'un projet publie automatiquement les modifications qui sont transmises. Si vous avez désactivé la génération du flux de travail lors de la création du plan, celui-ci n'est pas automatiquement disponible pour être ajouté au catalogue de plans de votre espace. Vous pouvez toujours publier votre plan personnalisé sur votre espace après avoir exécuté une yarn commande.

Pour afficher et publier un plan personnalisé

1. Reprenez votre environnement de développement. Pour plus d’informations, consultez Reprise d'un environnement de développement.

2. Ouvrez un terminal fonctionnel dans votre environnement de développement.

3. • Si vous avez refusé la génération du flux de travail de publication lors de la création de votre plan, utilisez la commande suivante :

     yarn blueprint:release

     Vous pouvez toujours accéder au See this blueprint at: lien fourni pour afficher votre plan personnalisé.

     Publiez la version mise à jour de votre plan personnalisé, qui peut ensuite être ajoutée au catalogue de plans de votre espace. Accédez au Enable version [release version number] at: lien pour publier la dernière version sur votre espace.

   • Si vous avez opté pour un flux de publication lors de la création de votre plan, la dernière version du plan est automatiquement publiée lorsque les modifications sont apportées. Utilisez les commandes suivantes :

     git add .

     git commit -m "commit message"

     git push

Après avoir publié votre version normale, vous pouvez ajouter le plan afin que les membres de l'espace puissent l'utiliser pour créer de nouveaux projets ou ajouter des projets existants. Pour de plus amples informations, veuillez consulter Ajouter un plan personnalisé à un catalogue de plans spatiaux.

Publication et ajout d'un plan personnalisé dans des espaces et des projets spécifiques

Par défaut, les blueprint:release commandes blueprint:preview et sont publiées dans l' CodeCatalyst espace dans lequel vous avez créé le plan. Si vous disposez de plusieurs espaces Enterprise, vous pouvez également prévisualiser et publier le même plan dans ces espaces. Vous pouvez également ajouter un plan à un projet existant d'un autre espace.

Pour publier ou ajouter un plan personnalisé dans un espace spécifié

1. Reprenez votre environnement de développement. Pour de plus amples informations, veuillez consulter Reprise d'un environnement de développement.

2. Ouvrez un terminal fonctionnel dans votre environnement de développement.

3. (Facultatif) Installez les dépendances nécessaires pour votre projet si vous ne les avez pas déjà installées. Utilisez la commande suivante :

   yarn

4. Utilisez la --space balise pour publier un aperçu ou une version normale dans un espace spécifié. Par exemple :

   • yarn blueprint:preview --space my-awesome-space # publishes under a "preview" version tag to 'my-awesome-space'

     Exemple de sortie :

     Enable version 0.0.1-preview.0 at: https://codecatalyst.aws/spaces/my-awesome-space/blueprints
     Blueprint applied to [NEW]: https://codecatalyst.aws/spaces/my-awesome-space/blueprints/%40amazon-codecatalyst%2Fmyspace.my-blueprint/publishers/1524817d-a69b-4abe-89a0-0e4a9a6c53b2/versions/0.0.1-preview.0/projects/create

   • yarn blueprint:release --space my-awesome-space # publishes normal version to 'my-awesome-space'

     Exemple de sortie :

     Enable version 0.0.1 at: https://codecatalyst.aws/spaces/my-awesome-space/blueprints
     Blueprint applied to [NEW]: https://codecatalyst.aws/spaces/my-awesome-space/blueprints/%40amazon-codecatalyst%2Fmyspace.my-blueprint/publishers/1524817d-a69b-4abe-89a0-0e4a9a6c53b2/versions/0.0.1/projects/create

   Utilisez le --project pour ajouter une version d'aperçu d'un plan personnalisé à un projet existant dans un espace spécifié. Par exemple :

   yarn blueprint:preview --space my-awesome-space --project my-project # previews blueprint application to an existing project

   Exemple de sortie :

   Enable version 0.0.1-preview.1 at: https://codecatalyst.aws/spaces/my-awesome-space/blueprints
   Blueprint applied to [my-project]: https://codecatalyst.aws/spaces/my-awesome-space/projects/my-project/blueprints/%40amazon-codecatalyst%2FmySpace.my-blueprint/publishers/1524817d-a69b-4abe-89a0-0e4a9a6c53b2/versions/0.0.1-preview.1/add