democlap

Intégration continue

Vos tutoriels vidéo refaits à chaque mise en production, depuis votre CI

Ajoutez un job à votre pipeline. Une fois le déploiement réussi, il envoie un appel HTTP à Democlap, qui rejoue tous les scripts du projet sur votre environnement de démo, régénère les vidéos et marque « À refaire » celles dont un écran a changé, au lieu de les publier.

Le déclenchement par CI fait partie des offres Pro et Enterprise. Sur toutes les offres, une release peut aussi partir d'un clic dans le studio (page Tournages) ou d'un créneau hebdomadaire.

Mise en place en quatre étapes

  1. Créez un jeton de release

    Dans le studio, page Tournages. Le jeton n'est affiché qu'une fois et seule son empreinte est conservée. Vous pouvez le révoquer à tout moment ; sa création et sa révocation sont inscrites au journal d'audit.

  2. Enregistrez-le comme secret

    Un secret de dépôt DEMOCLAP_TOKEN sur GitHub, une variable CI/CD masquée du même nom sur GitLab. Le jeton ne doit jamais apparaître dans le code.

  3. Ajoutez le job après le déploiement

    L'appel doit partir quand la nouvelle version est en ligne sur l'environnement de démo, sinon Democlap filmerait l'ancienne. Les deux exemples ci-dessous respectent cet ordre.

  4. Democlap tourne, vous approuvez

    Chaque script est rejoué et la vidéo est régénérée dans les langues prévues. Par défaut, une nouvelle vidéo attend votre approbation avant publication. Un script qui ne trouve plus un élément de l'écran n'est pas publié : il est marqué « À refaire », avec l'étape en cause.

Exemple pour GitHub Actions

Fichier .github/workflows/democlap.yml. Le workflow se lance sur l'événement deployment_status, que publient par exemple Vercel et Netlify, et n'appelle Democlap que si le déploiement a réussi.

name: Democlap
on:
  deployment_status:
jobs:
  release:
    if: github.event.deployment_status.state == 'success'
    runs-on: ubuntu-latest
    steps:
      - name: Democlap release
        env:
          DEMOCLAP_TOKEN: ${{ secrets.DEMOCLAP_TOKEN }}
        run: |
          curl -fsS -X POST "https://www.democlap.com/api/releases" \
            -H "Authorization: Bearer $DEMOCLAP_TOKEN" \
            -H "Content-Type: application/json" \
            -d '{"project":"mon-projet","source":"ci"}'

Exemple pour GitLab CI

À ajouter à .gitlab-ci.yml. Le job tourne à l'étape .post, donc après le déploiement du même pipeline, et seulement sur la branche par défaut.

democlap-release:
  stage: .post
  image:
    name: curlimages/curl:8.10.1
    entrypoint: [""]
  rules:
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
  script:
    - >
      curl -fsS -X POST "https://www.democlap.com/api/releases"
      -H "Authorization: Bearer $DEMOCLAP_TOKEN"
      -H "Content-Type: application/json"
      -d '{"project":"mon-projet","source":"ci"}'

« mon-projet » est un exemple : dans le studio, page Tournages, les mêmes exemples sont déjà remplis avec l'identifiant de votre projet. Le champ facultatif « environment » choisit un plateau par son nom ; sans lui, Democlap utilise le premier plateau créé pour le projet.

Ce que fait l'appel

Adresse
POST /api/releases sur www.democlap.com
Authentification
En-tête Authorization: Bearer suivi du jeton de release
Corps
JSON : « project » (identifiant du projet, obligatoire), « environment » (nom du plateau, facultatif), « source » (« ci »)
Réponse
202 dès que la release est en file d'attente, avec son identifiant. Le pipeline n'attend pas la fin du tournage.
Refus
401 jeton absent, révoqué ou expiré · 403 offre Starter, abonnement inactif ou quota atteint · 404 projet ou plateau inconnu · 409 une release tourne déjà sur ce projet · 422 aucun script à tourner · 429 plus d'un appel toutes les 5 secondes avec le même jeton
Données
L'appel ne transmet que l'identifiant du projet : ni code source, ni accès à votre dépôt. Democlap filme l'interface de votre environnement de démo avec le compte enregistré sur le plateau.

Sans CI, ou sur l'offre Starter

La même release se lance d'un clic dans le studio, page Tournages, ou automatiquement sur un créneau hebdomadaire (jour et heure de Paris) réglé par projet. Le résultat est identique : les scripts sont rejoués, les vidéos régénérées, les scripts cassés signalés.

Questions fréquentes

Faut-il donner à Democlap un accès à notre dépôt de code ?

Non. Democlap ne lit pas votre dépôt : le job envoie seulement un appel HTTP avec l'identifiant du projet. Les scripts sont rejoués sur l'interface de votre environnement de démo, comme le ferait un utilisateur.

Le pipeline attend-il la fin du tournage ?

Non. L'API répond dès que la release est en file d'attente ; le tournage se fait ensuite, et vous suivez chaque vidéo dans la bibliothèque du studio.

Que se passe-t-il si un écran a changé ?

Le script s'arrête à l'étape dont l'élément est introuvable, la vidéo n'est pas publiée et le script est marqué « À refaire » avec l'étape en cause. Les propriétaires et administrateurs de l'organisation reçoivent par e-mail le récapitulatif de la release : vidéos à jour, scripts cassés et lien vers chacun.

Nous déployons plusieurs fois par jour : est-ce un problème ?

Une seule release tourne à la fois par projet : un appel reçu pendant qu'elle tourne est refusé (409) et n'est pas mis en attente. Si vous déployez souvent, appelez Democlap depuis le pipeline de la branche de production seulement, ou sur un tag de version.

Quelle offre faut-il ?

Pro ou Enterprise pour le déclenchement par CI. Le pilote d'un mois comprend au moins une régénération sur une vraie mise en production de votre logiciel, par webhook, CI ou déclenchement manuel.

Pour aller plus loin