Continuous integration
Your video tutorials rebuilt on every production release, from your CI
Add one job to your pipeline. Once the deployment succeeds, it sends an HTTP call to Democlap, which replays every script of the project on your demo environment, regenerates the videos and marks the ones whose screens changed as "Needs a retake" instead of publishing them.
Triggering from CI is part of the Pro and Enterprise plans. On every plan, a release can also start with one click in the studio (Shoots page) or on a weekly slot.
Set up in four steps
Create a release token
In the studio, on the Shoots page. The token is shown once and only its fingerprint is stored. You can revoke it at any time; its creation and revocation are written to the audit log.
Store it as a secret
A DEMOCLAP_TOKEN repository secret on GitHub, a masked CI/CD variable with the same name on GitLab. The token must never appear in your code.
Add the job after the deployment
The call must go out once the new version is live on the demo environment, otherwise Democlap would film the old one. Both examples below follow that order.
Democlap shoots, you approve
Every script is replayed and the video is regenerated in its planned languages. By default, a new video waits for your approval before it is published. A script that can no longer find an element on screen is not published: it is marked "Needs a retake", with the failing step.
GitHub Actions example
File .github/workflows/democlap.yml. The workflow runs on the deployment_status event, which Vercel and Netlify for example publish, and only calls Democlap when the deployment succeeded.
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":"my-project","source":"ci"}'GitLab CI example
Add to .gitlab-ci.yml. The job runs in the .post stage, so after the deploy job of the same pipeline, and only on the default branch.
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":"my-project","source":"ci"}'"my-project" is an example: in the studio, on the Shoots page, the same examples are already filled in with your project identifier. The optional "environment" field picks a set by its name; without it, Democlap uses the first set created for the project.
What the call does
- Endpoint
- POST /api/releases on www.democlap.com
- Authentication
- Authorization: Bearer header followed by the release token
- Body
- JSON: "project" (project identifier, required), "environment" (set name, optional), "source" ("ci")
- Response
- 202 as soon as the release is queued, with its identifier. The pipeline does not wait for the shoot to finish.
- Refusals
- 401 missing, revoked or expired token · 403 Starter plan, inactive subscription or quota reached · 404 unknown project or set · 409 a release is already running on this project · 422 no script to shoot · 429 more than one call every 5 seconds with the same token
- Data
- The call only carries the project identifier: no source code, no access to your repository. Democlap films the interface of your demo environment with the account saved on the set.
Without CI, or on the Starter plan
The same release starts with one click in the studio, on the Shoots page, or automatically on a weekly slot (Paris day and time) set per project. The result is the same: scripts are replayed, videos regenerated, broken scripts flagged.
Frequently asked questions
Do we need to give Democlap access to our code repository?
No. Democlap does not read your repository: the job only sends an HTTP call with the project identifier. Scripts are replayed on the interface of your demo environment, the way a user would.
Does the pipeline wait for the shoot to finish?
No. The API answers as soon as the release is queued; the shoot happens afterwards, and you follow each video in the studio library.
What happens when a screen has changed?
The script stops at the step whose element cannot be found, the video is not published and the script is marked "Needs a retake" with the failing step. The organization's owners and admins receive the release summary by e-mail: videos up to date, broken scripts and a link to each.
We deploy several times a day: is that a problem?
Only one release runs at a time per project: a call received while it runs is refused (409) and not queued. If you deploy often, call Democlap from the production branch pipeline only, or on a version tag.
Which plan do we need?
Pro or Enterprise for CI triggers. The one-month pilot includes at least one regeneration on a real production release of your software, through a webhook, CI or a manual trigger.