For the complete documentation index, see llms.txt. This page is also available as Markdown.

Choosing your integration

Pick the right Duku integration for your deployment model.

Duku can be triggered four ways: Schedules, the preview action, the environment action, and the Platform API. The right fit depends on how you deploy, and whether you automate it. Use the steps below to pick a route, then open the setup guide.

Find your route

Answer these in order and stop as soon as one applies.

1

1. Do you automate deployments in your CI/CD pipeline?

  • No: Use Schedules. Set a recurring cadence in Viewport. No pipeline needed.

  • Yes: Go to question 2.

2

2. Do you use GitHub Actions for CI/CD?

  • No: Use the GraphQL API. This fits CircleCI, GitLab, Jenkins, and similar tools.

  • Yes: Go to question 3.

3

3. Does every pull request get its own preview environment with a unique URL?

If you use GitHub Actions, use Choosing preview vs environment for the final split between preview and environment.

Compare the routes

Route
Best for
Typical trigger
What Duku explores
How results surface
Set it up

Schedules

Recurring coverage with no pipeline wiring, or no automated deploys

A cadence you set in Viewport

Any target you point it at

In Viewport

Preview action

GitHub Actions where every PR gets its own preview URL

pull_request

The PR's preview deployment

Sticky PR comment that updates in place with results

Environment action

GitHub Actions against a stable, pre-created environment like staging, canary, or prod

push, schedule, workflow_dispatch, or pull_request for a protected branch

A fixed target you created in Viewport

In Viewport. Duku also posts a PR comment when you run on pull_request, or when you pass repository and PR metadata, and the Duku GitHub App is installed. There is no merge-gating Check Run yet.

Platform API

Any other CI, such as CircleCI, GitLab CI, or Jenkins, or a custom pipeline

Whenever your pipeline calls it

Any URL you pass in

In Viewport. You can also post a PR comment when you pass PR metadata. See the tip below.

Get PR comments without GitHub Actions

If you use the Platform API and still want GitHub PR comments, pass githubRepository, githubPrNumber, and serverManagedComment: true to startExploration.

Duku's GitHub App posts the in-progress comment and updates it in place when the run finishes. You do not need a GitHub Action.

This only requires the Duku GitHub App to be installed on the repository. The App is a one-time install. It posts comments through the GitHub API, and uses no CI minutes.

Under the hood

All three managed routes, Schedules, preview, and environment, call the same Platform API underneath. If an action does not expose a parameter you need, you can drop down to direct API calls.

Last updated