Badges and sharing
Build status badges
A badge is a small live SVG showing the latest build status of one build target, for a README or
status page. It only exposes a status word (passing, failing, building, queued, or
unknown) and, for a passing build, the app version. Nothing else about the project is shown.
Find them in your project under Settings → General → Status badges
(https://app.venelx.com/project/<projectId>/settings):
- Make sure Public badges is on. When it is off, the badge shows "not found".
- Optionally enter a branch filter; empty means the latest build of the target.
- Copy the Markdown snippet for the target you want.
The URL looks like this:
https://api.venelx.com/api/badge/<projectId>/<targetId>.svg
<targetId> is the build target id (for example ios or android-preview). Optional query
parameters: branch (only builds from that branch) and label (custom left-hand text).
Pull request builds are not counted.
Share a build with a public link
By default builds, logs and downloads need you to be signed in. To share one build with anyone:
- Open the project's Build history (
https://app.venelx.com/project/<projectId>/history). - On the build, click the Private button to switch it to Public.
- Use Copy URL (download page) or the logs link.
Public builds are available at:
| Link | What it gives |
|---|---|
https://app.venelx.com/public/download/<buildId> | The download page for the artifact. |
https://app.venelx.com/public/logs/<buildId> | The build log. Secrets are redacted from public logs. |
The same data is available from the API without authentication, only for public builds:
GET /api/public/artifact/<buildId>, GET /api/public/logs/<buildId> and
GET /api/public/download/<buildId>. A private build answers "This artifact is private".
Switch the build back to Private at any time to stop sharing it.
Anyone with a public link can download the artifact and read its (redacted) log. Don't make a build public if the app or its logs must stay confidential.
QR code install
For a public build, a QR code image is available at:
https://api.venelx.com/api/public/qr/<buildId>.png
It encodes the public download page, so someone can scan it with a phone to install. The QR is only served for public builds. Pull request comments include the QR automatically when the build is public.