Amazon n' CodeCatalyst est plus ouvert aux nouveaux clients. Les clients existants peuvent continuer à utiliser le service normalement. Pour de plus amples informations, veuillez consulter Comment effectuer une migration depuis CodeCatalyst.
Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Commencer à utiliser les référentiels CodeCatalyst sources et le plan de l' Single-page application
Suivez les étapes de ce didacticiel pour apprendre à utiliser les référentiels sources sur Amazon CodeCatalyst.
Le moyen le plus rapide de commencer à utiliser les référentiels sources d'Amazon CodeCatalyst est de créer un projet à l'aide d'un modèle. Lorsque vous créez un projet à l'aide d'un modèle, des ressources sont créées pour vous, notamment un référentiel source contenant des exemples de code. Vous pouvez utiliser ce référentiel et cet exemple de code pour apprendre à :
-
Afficher les référentiels sources d'un projet et parcourir leur contenu
-
Créez un environnement de développement avec une nouvelle branche dans laquelle vous pouvez travailler sur du code
-
Modifiez un fichier, validez et transférez vos modifications
-
Créez une pull request et passez en revue les modifications apportées à votre code avec les autres membres du projet
-
Consultez le flux de travail de votre projet, créez et testez automatiquement les modifications dans la branche source de la pull request
-
Fusionnez les modifications de votre branche source dans la branche de destination et fermez la pull request
-
Voir les modifications fusionnées créées et déployées automatiquement
Pour tirer le meilleur parti de ce didacticiel, invitez d'autres personnes à participer à votre projet afin de pouvoir travailler ensemble sur une pull request. Vous pouvez également explorer des fonctionnalités supplémentaires dans CodeCatalyst, telles que la création de problèmes et leur association à une pull request, ou la configuration des notifications et la réception d'alertes lorsque le flux de travail associé s'exécute. Pour une exploration complète de CodeCatalyst, voirTutoriels de mise en route.
Création d'un projet avec un plan
La création d'un projet est la première étape pour pouvoir travailler ensemble. Vous pouvez utiliser un plan pour créer votre projet, qui créera également un référentiel source contenant des exemples de code et un flux de travail qui créera et déploiera automatiquement votre code lorsque vous le modifiez. Dans ce didacticiel, nous allons vous présenter un projet créé avec le plan de l'Single-page application, mais vous pouvez suivre les procédures pour tout projet doté d'un référentiel source. Assurez-vous de choisir un rôle IAM ou d'ajouter un rôle IAM si vous n'en avez pas lors de la création du projet. Nous vous recommandons d'utiliser le rôle CodeCatalystWorkflowDevelopmentRole- spaceName de service pour ce projet.
Si vous avez déjà un projet, vous pouvez passer directement àAfficher les référentiels d'un projet.
Note
Seuls les utilisateurs dotés du rôle d'administrateur de l'espace ou d'utilisateur expérimenté peuvent créer des projets dans CodeCatalyst. Si vous n'avez pas ce rôle et que vous avez besoin d'un projet sur lequel travailler pour ce didacticiel, demandez à une personne possédant l'un de ces rôles de créer un projet pour vous et de vous y ajouter. Pour de plus amples informations, veuillez consulter Octroi d'un accès avec des rôles d'utilisateur.
Pour créer un projet avec un plan
-
Dans la CodeCatalyst console, accédez à l'espace dans lequel vous souhaitez créer un projet.
-
Sur le tableau de bord de l'espace, choisissez Créer un projet.
-
Choisissez Commencer par un plan.
Astuce
Vous pouvez choisir d'ajouter un plan en indiquant à Amazon Q les exigences de votre projet pour qu'Amazon Q vous suggère un plan. Pour plus d’informations, consultez Utiliser Amazon Q pour choisir un plan lors de la création d'un projet ou de l'ajout de fonctionnalités et Meilleures pratiques lors de l'utilisation d'Amazon Q pour créer des projets ou ajouter des fonctionnalités à l'aide de plans. Cette fonctionnalité n'est disponible que dans la région Ouest des États-Unis (Oregon).
Cette fonctionnalité nécessite que les fonctionnalités d'IA génératives soient activées pour l'espace. Pour plus d'informations, consultez la section Gestion des fonctionnalités génératives d'IA.
-
Dans l'onglet CodeCatalyst Plans ou Plans spatiaux, choisissez un plan, puis choisissez Suivant.
-
Dans Nommez votre projet, entrez le nom que vous souhaitez attribuer à votre projet et les noms des ressources associées. Le nom doit être unique dans votre espace.
-
(Facultatif) Par défaut, le code source créé par le Blueprint 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 de plus amples informations, veuillez consulter Ajoutez des fonctionnalités aux projets avec des extensions dans CodeCatalyst.
Important
CodeCatalyst ne prend pas en charge la détection de modifications dans la branche par défaut pour les référentiels liés. Pour modifier la branche par défaut d'un référentiel lié, vous devez d'abord le dissocier CodeCatalyst, modifier la branche par défaut, puis la lier à nouveau. Pour de plus amples informations, veuillez consulter Lier GitHub des référentiels, des référentiels Bitbucket, des référentiels de GitLab projets et des projets Jira dans CodeCatalyst.
Il est recommandé de toujours disposer de la dernière version de l'extension avant de lier un référentiel.
Effectuez l'une des opérations 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 dans lequel vous souhaitez stocker le code source créé par le Blueprint.
Note
Si vous connectez un GitHub compte, vous devez créer une connexion personnelle pour établir un mappage d'identité entre votre CodeCatalyst identité et la GitHub vôtre. Pour plus d’informations, consultez Connexions personnelles et Accès à GitHub des ressources grâce à des liens personnels.
-
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 Blueprint.
-
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 Blueprint.
-
-
Sous Ressources du projet, configurez les paramètres du plan. Selon le plan, vous pouvez avoir la possibilité de nommer le nom du référentiel source.
-
(Facultatif) 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 projet.
-
(Facultatif) Choisissez Afficher les détails dans la fiche du plan pour afficher des détails spécifiques sur le plan, tels qu'un aperçu de l'architecture du plan, des connexions et des autorisations requises, ainsi que le type de ressources que le plan crée.
-
Sélectionnez Create a project (Créer un projet).
La page de présentation du projet s'ouvre dès que vous créez un projet ou que vous acceptez une invitation à participer à un projet et que vous terminez le processus de connexion. La page de présentation d'un nouveau projet ne contient aucun problème en cours ni aucune demande d'extraction. Vous pouvez éventuellement choisir de créer un problème et de vous l'attribuer vous-même. Vous pouvez également choisir d'inviter quelqu'un d'autre à participer à votre projet. Pour plus d’informations, consultez Création d'un problème dans CodeCatalyst et Inviter un utilisateur à participer à un projet.
Afficher les référentiels d'un projet
En tant que membre d'un projet, vous pouvez consulter les référentiels sources du projet. Vous pouvez également choisir de créer des référentiels supplémentaires. Si une personne ayant le rôle d'administrateur Space a installé et configuré les GitHub référentiels, les référentiels Bitbucket ou l'extension des GitLab référentiels, vous pouvez également ajouter des liens vers des référentiels tiers dans les GitHub comptes, les espaces de travail Bitbucket ou les utilisateurs configurés pour l'extension. GitLab Pour plus d’informations, consultez Création d'un référentiel source et Démarrage rapide : installation d'extensions, connexion de fournisseurs et liens de ressources dans CodeCatalyst.
Note
Pour les projets créés avec le plan d' Single-page application, le nom par défaut du référentiel source contenant l'exemple de code est spa-app.
Pour accéder aux référentiels sources d'un projet
-
Accédez à votre projet et effectuez l'une des opérations suivantes :
Sur la page de résumé de votre projet, choisissez le référentiel de votre choix dans la liste, puis choisissez Afficher le référentiel.
-
Dans le volet de navigation, choisissez Code, puis choisissez Référentiels sources. Dans Référentiels sources, choisissez le nom du référentiel dans la liste. Vous pouvez filtrer la liste des référentiels en saisissant une partie du nom du référentiel dans la barre de filtre.
-
Sur la page d'accueil du référentiel, consultez le contenu du référentiel et des informations sur les ressources associées, telles que le nombre de demandes d'extraction et les flux de travail. Par défaut, le contenu de la branche par défaut est affiché. Vous pouvez modifier l'affichage en choisissant une autre branche dans la liste déroulante.
La page de présentation du référentiel contient des informations sur les flux de travail et les demandes d'extraction configurés pour les branches de ce référentiel et ses fichiers. Si vous venez de créer le projet, les flux de travail initiaux pour créer, tester et déployer le code seront toujours en cours d'exécution, car ils ne prennent que quelques minutes. Vous pouvez consulter les flux de travail associés et leur statut en choisissant le numéro sous Workflows associés, mais la page Workflows s'ouvre dans CI/CD. Pour ce didacticiel, restez sur la page de présentation et explorez le code du référentiel. Le contenu du README.md fichier est affiché sur cette page, sous les fichiers du référentiel. Dans Fichiers, le contenu de la branche par défaut est affiché. Vous pouvez modifier l'affichage du fichier pour afficher le contenu d'une autre branche si vous en avez une. Le .codecatalyst dossier contient du code utilisé pour d'autres parties du projet, comme les fichiers YAML du flux de travail.
Pour afficher le contenu des dossiers, cliquez sur la flèche à côté du nom du dossier pour le développer. Par exemple, cliquez sur la flèche à côté de src pour afficher les fichiers de l'application Web d'une seule page contenue dans ce dossier. Pour afficher le contenu d'un fichier, sélectionnez ce dernier dans la liste. Cela ouvrira Afficher les fichiers, où vous pourrez parcourir le contenu de plusieurs fichiers. Vous pouvez également modifier des fichiers individuels dans la console, mais pour modifier plusieurs fichiers, vous devez créer un environnement de développement.
Création d’un environnement de développement
Vous pouvez ajouter et modifier des fichiers dans un référentiel source dans la CodeCatalyst console Amazon. Toutefois, pour travailler efficacement avec plusieurs fichiers et branches, nous vous recommandons d'utiliser un environnement de développement ou de cloner le référentiel sur votre ordinateur local. Dans ce didacticiel, nous allons créer un AWS Cloud9 environnement de développement avec une branche nomméedevelop. Vous pouvez choisir un autre nom de branche, mais en nommant la branchedevelop, un flux de travail sera automatiquement exécuté pour créer et tester votre code lorsque vous créerez une pull request plus loin dans ce didacticiel.
Astuce
Si vous décidez de cloner un dépôt localement au lieu ou en plus d'utiliser un environnement de développement, assurez-vous que Git est installé sur votre ordinateur local ou que votre IDE inclut Git. Pour de plus amples informations, veuillez consulter Configuration pour travailler avec les référentiels sources.
Pour créer un environnement de développement avec une nouvelle branche
Ouvrez la CodeCatalyst console à l'adresse https://codecatalyst.aws/
. Accédez au projet dans lequel vous souhaitez créer un environnement de développement.
Choisissez le nom du référentiel dans la liste des référentiels sources du projet. Sinon, dans le volet de navigation, choisissez Code, choisissez Dépôts sources, puis choisissez le référentiel pour lequel vous souhaitez créer un environnement de développement.
Sur la page d'accueil du référentiel, choisissez Create Dev Environment.
Choisissez un IDE compatible dans le menu déroulant. Pour plus d’informations, consultez Environnements de développement intégrés pris en charge pour les environnements de développement.
Choisissez le référentiel à cloner, choisissez Travailler dans une nouvelle branche, entrez un nom de branche dans le champ Nom de la branche et choisissez une branche à partir de laquelle créer la nouvelle branche dans le menu déroulant Créer une branche à partir du menu déroulant.
Vous pouvez éventuellement ajouter un alias pour l'environnement de développement.
Vous pouvez également cliquer sur le bouton Modifier la configuration de l'environnement de développement pour modifier la configuration de calcul, de stockage ou de temporisation de l'environnement de développement.
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 affiche Exécution une fois l'environnement de développement créé. Un nouvel onglet s'ouvrira avec votre environnement de développement dans l'IDE de votre choix. Vous pouvez modifier le code, valider et appliquer vos modifications.
Une fois que vous avez créé l'environnement de développement, vous pouvez modifier des fichiers, valider vos modifications et les transmettre à la test branche. Pour ce didacticiel, modifiez le contenu entre les <p> balises du App.tsx fichier dans le src dossier afin de modifier le texte affiché sur la page Web. Validez et appuyez sur votre modification, puis revenez à l' CodeCatalyst onglet.
Pour effectuer et appliquer une modification à partir d'un AWS Cloud9 Environnement de développement
-
Dans AWS Cloud9, développez le menu de navigation latéral pour parcourir les fichiers.
srcDéveloppez et ouvrezApp.tsx. -
Modifiez le texte à l'intérieur des
<p>balises. -
Enregistrez le fichier, puis validez et transférez vos modifications à l'aide du menu Git. Sinon, dans la fenêtre du terminal, validez et envoyez vos modifications à l'aide git commit des git push commandes et.
git commit -am "Making an example change" git pushAstuce
Vous devrez peut-être remplacer les répertoires du terminal par le répertoire du référentiel Git avant de pouvoir exécuter correctement les commandes Git.
Création d’une demande pull
Vous pouvez utiliser les pull requests pour examiner les modifications de code de manière collaborative afin de détecter des modifications ou des corrections mineures, des ajouts de fonctionnalités majeurs ou de nouvelles versions de votre logiciel publié. Dans ce didacticiel, vous allez créer une pull request pour passer en revue les modifications que vous avez apportées à la test branche par rapport à la branche principale. La création d'une pull request dans un projet créé à l'aide d'un modèle lancera également l'exécution des flux de travail associés, le cas échéant.
Pour créer une demande d’extraction
-
Accédez à votre projet.
-
Effectuez l’une des actions suivantes :
-
Dans le volet de navigation, choisissez Code, choisissez Pull requests, puis choisissez Create pull request.
-
Sur la page d'accueil du référentiel, choisissez Plus, puis choisissez Créer une demande d'extraction.
-
Sur la page du projet, choisissez Create pull request.
-
-
Dans Référentiel source, assurez-vous que le référentiel source spécifié est celui qui contient le code validé. Cette option n'apparaît que si vous n'avez pas créé la pull request depuis la page principale du référentiel.
-
Dans Branche de destination, choisissez la branche dans laquelle fusionner le code après l'avoir révisé.
-
Dans Branche source, choisissez la branche qui contient le code validé.
-
Dans Titre de la demande d'extraction, saisissez un titre qui aide les autres utilisateurs à comprendre ce qui doit être révisé et pourquoi.
-
(Facultatif) Dans la description de la demande Pull, fournissez des informations telles qu'un lien vers les problèmes ou une description de vos modifications.
Astuce
Vous pouvez choisir Écrire une description pour que je génère CodeCatalyst automatiquement une description des modifications contenues dans la pull request. Vous pouvez apporter des modifications à la description générée automatiquement après l'avoir ajoutée à la pull request.
Cette fonctionnalité nécessite que les fonctionnalités d'IA génératives soient activées pour l'espace et n'est pas disponible pour les demandes d'extraction dans les référentiels liés. Pour plus d'informations, consultez la section Gestion des fonctionnalités génératives d'IA.
-
(Facultatif) Dans Problèmes, choisissez Lier les problèmes, puis choisissez un problème dans la liste ou entrez son identifiant. Pour dissocier un problème, cliquez sur l'icône de dissociation.
-
(Facultatif) Dans Réviseurs obligatoires, choisissez Ajouter les réviseurs requis. Choisissez parmi la liste des membres du projet pour les ajouter. Les réviseurs requis doivent approuver les modifications avant que la pull request puisse être fusionnée dans la branche de destination.
Note
Vous ne pouvez pas ajouter de réviseur à la fois en tant que réviseur obligatoire et en tant que réviseur facultatif. Vous ne pouvez pas vous ajouter en tant que réviseur.
-
(Facultatif) Dans Réviseurs facultatifs, choisissez Ajouter des réviseurs facultatifs. Choisissez parmi la liste des membres du projet pour les ajouter. Les réviseurs facultatifs n'ont pas à approuver les modifications comme condition préalable pour que la pull request puisse être fusionnée dans la branche de destination.
-
Passez en revue les différences entre les branches. La différence affichée dans une pull request réside dans les changements entre la révision de la branche source et la base de fusion, qui est le commit principal de la branche de destination au moment de la création de la pull request. Si aucune modification n'est affichée, les branches sont peut-être identiques ou vous avez peut-être choisi la même branche pour la source et la destination.
-
Lorsque vous êtes convaincu que la pull request contient le code et les modifications que vous souhaitez revoir, choisissez Create.
Note
Après avoir créé la pull request, vous pouvez ajouter des commentaires. Les commentaires peuvent être ajoutés à la demande d'extraction ou à des lignes individuelles de fichiers, ainsi qu'à la demande d'extraction globale. Vous pouvez ajouter des liens vers des ressources, telles que des fichiers, en utilisant le signe @ suivi du nom du fichier.
Vous pouvez consulter les informations sur les flux de travail associés lancés par la création de cette demande d'extraction en choisissant Aperçu, puis en consultant les informations dans la zone Détails de la demande d'extraction sous Exécutions du flux de travail. Pour afficher le flux de travail exécuté, choisissez l'exécution.
Astuce
Si vous avez donné un autre nom à votre branchedevelop, aucun flux de travail ne sera automatiquement exécuté pour créer et tester vos modifications. Si vous souhaitez configurer cela, modifiez le fichier YAML pour le PullRequestBuildAndTest flux de travail activé. Pour de plus amples informations, veuillez consulter Création d'un flux de travail.
Vous pouvez commenter cette pull request et demander aux autres membres du projet de la commenter. Vous pouvez également choisir d'ajouter ou de modifier des réviseurs facultatifs ou obligatoires. Vous pouvez choisir d'apporter d'autres modifications à la branche source du référentiel et voir comment ces modifications validées créent des révisions pour la pull request. Pour plus d'informationsRévision d’une demande pull, consultezMise à jour d’une demande pull,Révision du code à l'aide de pull requests sur Amazon CodeCatalyst, etAfficher le statut et les détails de l'exécution du flux de travail.
Fusion d’une demande pull
Une fois qu'une pull request a été examinée et a reçu les approbations des réviseurs requis, vous pouvez fusionner sa branche source avec la branche de destination dans la CodeCatalyst console. La fusion d'une pull request lancera également une série de modifications dans tous les flux de travail associés à la branche de destination. Dans ce didacticiel, vous allez fusionner la branche test dans la branche main, ce qui lancera l'exécution du PushToMainDeployPipeline flux de travail on.
Pour fusionner une pull request (console)
-
Dans Pull requests, choisissez la pull request que vous avez créée à l'étape précédente. Dans la pull request, choisissez Fusionner.
-
Choisissez parmi les stratégies de fusion disponibles pour la pull request. Vous pouvez éventuellement sélectionner ou désélectionner l'option permettant de supprimer la branche source après avoir fusionné la pull request, puis choisissez Fusionner. Une fois la fusion terminée, le statut de la demande d'extraction passe à Fusionné et n'apparaît plus dans la vue par défaut des demandes d'extraction. La vue par défaut affiche les pull requests dont le statut est Ouvert. Vous pouvez toujours consulter une pull request fusionnée, mais vous ne pouvez ni l'approuver ni modifier son statut.
Note
Si le bouton Fusionner n'est pas actif ou si vous voyez le libellé Non fusionnable, soit le réviseur requis n'a pas encore approuvé la pull request, soit la pull request ne peut pas être fusionnée dans la CodeCatalyst console. Un réviseur qui n'a pas approuvé une demande d'extraction est indiqué par une icône en forme d'horloge dans la section Aperçu de la zone de détails de la demande d'extraction. Si tous les réviseurs requis ont approuvé la pull request mais que le bouton Fusionner n'est toujours pas actif, il se peut qu'il y ait un conflit de fusion ou que vous ayez dépassé le quota de stockage de l'espace. Vous pouvez résoudre les conflits de fusion pour la branche de destination dans un environnement de développement, transférer les modifications, puis fusionner la pull request, ou vous pouvez résoudre les conflits et fusionner localement, puis envoyer le commit contenant la fusion vers CodeCatalyst. Pour plus d'informations, consultez Fusion d'une pull request (Git) et votre documentation Git.
Affichage du code déployé
Il est maintenant temps de consulter le code initialement déployé qui se trouvait dans la branche par défaut, ainsi que vos modifications fusionnées une fois qu'elles ont été automatiquement créées, testées et déployées. Pour ce faire, vous pouvez revenir à la page d'aperçu du référentiel et choisir le numéro à côté de l'icône des flux de travail associés, ou dans le volet de navigation, choisir CI/CD, puis choisir Workflows.
Pour afficher le code déployé
-
Dans Workflows, dans
onPushToMainDeployPipeline, développez Exécutions récentes.Note
Il s'agit du nom par défaut du flux de travail pour les projets créés avec le plan d'Single-page application.
-
L'exécution la plus récente est celle lancée par la validation de votre pull request fusionnée dans la
mainbranche et affichera probablement le statut En cours. Choisissez une exécution terminée avec succès dans la liste pour afficher les détails de cette exécution. -
Choisissez Variables. Copiez la valeur de AppURL. Il s'agit de l'URL de l'application Web monopage déployée. Ouvrez un nouvel onglet de navigateur et collez la valeur pour afficher le code créé et déployé. Laissez l'onglet ouvert.
-
Retournez à la liste des exécutions du flux de travail et attendez que la dernière exécution soit terminée. Lorsque c'est le cas, revenez à l'onglet que vous avez ouvert pour afficher l'application Web et actualisez votre navigateur. Vous devriez voir les modifications que vous avez apportées dans votre pull request fusionnée.
Nettoyage des ressources
Une fois que vous aurez exploré l'utilisation d'un référentiel source et d'une pull request, vous souhaiterez peut-être supprimer toutes les ressources dont vous n'avez pas besoin. Vous ne pouvez pas supprimer les pull requests, mais vous pouvez les fermer. Vous pouvez supprimer toutes les branches que vous avez créées.
Si vous n'avez plus besoin du référentiel source ou du projet, vous pouvez également supprimer ces ressources. Pour plus d'informations, consultez Supprimer un référentiel source et Suppression d’un projet.