Venelx Docs

Pull request previews

When someone opens or updates a pull request, Venelx can build the app automatically and comment on the PR with the result, so reviewers can try the change.

Set it up

  1. Connect GitHub and select the repository for the project.
  2. In the project, open Settings → GitHub and click Enable automatic builds. This registers the webhook that sends pull request and push events to Venelx.
  3. For each build target that should run on PRs, turn on Build on pull request in the project's build targets (Platforms & automatic builds). The GitHub tab lists which targets will run on PRs.

If you also want app tests on PRs, enable On pull request in Settings → Testing.

What happens

  • A PR build is queued for each PR-enabled target whenever the PR is opened or updated.
  • When it finishes, Venelx posts a comment on the PR: succeeded or failed, the duration, a link to the logs, and, for failures, the error.
  • If the build is public (see Badges and sharing) the comment also includes an install QR code and a download link. Otherwise the comment tells you how to make the build public.

See PR builds in the dashboard

PR builds lists every pull request that has been built, with the status of each platform build and links to the logs and to the PR on GitHub: https://app.venelx.com/project/<projectId>/pull-requests.

PR builds are separate from manual builds, which use the branch set in your GitHub settings. PR builds are not counted in status badges.