Aperçus Web pour les pull requests - AWS Amplify Hébergement

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.

Aperçus Web pour les pull requests

Les aperçus Web permettent aux équipes de développement et d'assurance qualité (QA) de prévisualiser les modifications apportées par les pull requests (PR) avant de fusionner le code dans une branche de production ou d'intégration. Les pull requests vous permettent d'informer les autres des modifications que vous avez apportées à une branche d'un référentiel. Après l'ouverture d'une pull request, vous pouvez discuter et examiner les modifications potentielles avec les collaborateurs et ajouter des validations de suivi avant que vos modifications ne soient fusionnées dans la branche de base.

Un aperçu Web déploie chaque pull request envoyée à votre référentiel vers une URL d'aperçu unique, complètement différente de l'URL utilisée par votre site principal. Pour les applications dont les environnements de backend sont provisionnés à l'aide de l'Amplify CLI ou d'Amplify Studio, chaque pull request (référentiels Git privés uniquement) crée un backend temporaire qui est supprimé à la fermeture du PR.

Lorsque les aperçus Web sont activés pour votre application, chaque PR est pris en compte dans le quota Amplify de 50 branches par application. Pour éviter de dépasser ce quota, assurez-vous de fermer vos PR. Pour de plus amples informations sur les quotas, veuillez consulter Quotas du service Amplify Hosting.

Note

Actuellement, la variable d'AWS_PULL_REQUEST_IDenvironnement n'est pas disponible lorsque vous l'utilisez en AWS CodeCommit tant que fournisseur de référentiel.

Activer les aperçus Web

Pour les applications stockées dans un GitHub dépôt, les aperçus utilisent l' GitHub application Amplify pour accéder au dépôt. Si vous activez les aperçus Web sur une application Amplify existante que vous avez précédemment déployée à partir d' GitHub un dépôt en utilisant OAuth pour y accéder, vous devez d'abord migrer l'application pour utiliser l'application Amplify. GitHub Pour les instructions de migration, voirMigration d'uneOAuth application existante vers l' GitHub application Amplify.

Important

Pour des raisons de sécurité, vous pouvez activer les aperçus Web sur toutes les applications dotées de référentiels privés, mais pas sur toutes les applications dotées de référentiels publics. Si votre référentiel Git est public, vous pouvez configurer des aperçus uniquement pour les applications qui ne nécessitent pas de rôle de service IAM.

Par exemple, les applications dotées de backends et les applications déployées sur la plate-forme WEB_COMPUTE d'hébergement nécessitent un rôle de service IAM. Par conséquent, vous ne pouvez pas activer les aperçus Web pour ces types d'applications si leur référentiel est public.

Amplify applique cette restriction pour empêcher des tiers de soumettre du code arbitraire qui serait exécuté en utilisant les autorisations de rôle IAM de votre application.

Pour activer les aperçus Web pour les pull requests
  1. Choisissez Hosting, puis Previews.

    Note

    Les aperçus sont visibles dans le menu des paramètres de l'application uniquement lorsqu'une application est configurée pour un déploiement continu et connectée à un dépôt git. Pour obtenir des instructions sur ce type de déploiement, voir Commencer avec le code existant.

  2. Pour les GitHub référentiels uniquement, procédez comme suit pour installer et autoriser l'application GitHub Amplify sur votre compte :

    1. Dans la fenêtre Installer GitHub l'application pour activer les aperçus, choisissez Installer GitHub l'application.

    2. Sélectionnez le GitHub compte sur lequel vous souhaitez configurer l'application Amplify GitHub.

    3. Une page s'ouvre sur GitHub.com pour configurer les autorisations de dépôt pour votre compte.

    4. Effectuez l’une des actions suivantes :

      • Pour appliquer l'installation à tous les référentiels, choisissez Tous les référentiels.

      • Pour limiter l'installation aux référentiels spécifiques que vous sélectionnez, choisissez Ne sélectionner que les référentiels. Assurez-vous d'inclure le dépôt de l'application pour laquelle vous activez les aperçus Web dans les référentiels que vous sélectionnez.

    5. Choisissez Enregistrer.

  3. Après avoir activé les aperçus pour votre dépôt, revenez à la console Amplify pour activer les aperçus pour des branches spécifiques. Sur la page des aperçus, sélectionnez une branche dans la liste et choisissez Modifier les paramètres.

  4. Sur la page Gérer les paramètres d'aperçu, activez les aperçus des demandes Pull. Ensuite, choisissez Valider.

  5. Pour les applications Fullstack, effectuez l'une des opérations suivantes :

    • Choisissez, créez un nouvel environnement principal pour chaque Pull Request. Cette option vous permet de tester les modifications sans affecter la production.

    • Choisissez Pointer toutes les pull requests pour cette branche vers un environnement existant.

  6. Choisissez Confirmer.

La prochaine fois que vous soumettrez une pull request pour la branche, Amplify crée et déploie votre PR vers une URL de prévisualisation. Une fois la pull request fermée, l'URL de prévisualisation est supprimée et tout environnement backend temporaire lié à la pull request est supprimé. Pour les GitHub référentiels uniquement, vous pouvez accéder à un aperçu de votre URL directement à partir de la pull request de votre GitHub compte.

Accès à l'aperçu Web avec des sous-domaines

Les aperçus Web pour les pull requests sont accessibles avec les sous-domaines d'une application Amplify connectée à un domaine personnalisé géré par Amazon Route 53. Lorsque la pull request est fermée, les branches et les sous-domaines associés à la pull request sont automatiquement supprimés. Il s'agit du comportement par défaut pour les aperçus Web une fois que vous avez configuré des déploiements de branches de fonctionnalités basés sur des modèles pour votre application. Pour obtenir des instructions sur la configuration de sous-domaines automatiques, consultezConfigurer des sous-domaines automatiques pour un domaine personnalisé Amazon Route 53.