Un environnement de prévisualisation pour chaque pull request

Un environnement de prévisualisation est une copie complète de votre application, déployée depuis une pull request, sur sa propre URL. Les relecteurs cliquent sur un lien au lieu de récupérer la branche, et les équipes produit et design vérifient un changement avant sa fusion. Ce guide le met en place en une dizaine de minutes.

Installer la CLI

La CLI sert à lier le dépôt et à tester la configuration en local.

npm install -g @cloud/cli

pnpm add -g @cloud/cli

yarn global add @cloud/cli

bun add -g @cloud/cli

Connectez-vous, puis liez le projet à la racine du dépôt :

cloud login
cloud link --project web-frontend

Activer les prévisualisations

Le fichier du projet se trouve à la racine du dépôt, à côté de package.json :

Les prévisualisations se configurent dans le fichier du projet. Le bloc previews indique quelles branches en obtiennent une, quelles variables d’environnement elles utilisent, et combien de temps elles restent en ligne après la fermeture de la pull request.

import { defineConfig } from "@cloud/cli";

export default defineConfig({
  service: "web-frontend",
  previews: {
    branches: ["*", "!main"],
    env: "preview",
    expireAfter: "3d",
  },
});

Commitez le fichier et ouvrez une pull request. La première prévisualisation se construit aussi vite qu’un déploiement normal, et le bot publie l’URL en commentaire.

Donner à chaque prévisualisation ses propres données

Une prévisualisation qui écrit dans la base de staging n’est pas vraiment isolée. Ajoutez une branche de base de données pour que chaque prévisualisation parte d’une copie du schéma et d’un petit jeu de données :

previews: {
  branches: ["*", "!main"],
  env: "preview",
  database: { branchFrom: "staging", seed: "./db/seed.sql" },
},

Les branches de base de données sont en copie sur écriture : en créer une prend quelques secondes, quelle que soit la taille de la base parente.

Nettoyer

Quand la pull request est fusionnée ou fermée, la prévisualisation et sa branche de base de données sont supprimées après expireAfter. Pour en supprimer une plus tôt :

cloud previews delete --pr 142

C’est tout. Désormais, chaque pull request a son lien, et rien ne reste en ligne après sa fermeture.