CI integration with GitHub Actions
Start Antidote from pull requests, deploys, and scheduled workflows.
Not sure which integration fits? Start here.
Use Duku's GitHub Actions to start explorations from your CI pipeline.
Not using GitHub Actions? See Triggering explorations from any CI to call the Platform API directly from any pipeline.
Use preview for short lived pull request previews. Use environment for stable targets like staging or a canary deployment.
Start here
Which action to use
preview
Per pull request previews, where each PR gets its own short lived target. Duku resolves the PR's preview deployment URL and explores it.
pull_request as the primary trigger. It also runs on push and workflow_dispatch. On those triggers, it only posts a PR comment when you pass repository and pr-number.
environment
Stable, long lived environments you declare once in Viewport, such as staging, a production canary, or a customer specific deploy. Each run is recorded as a release.
push to a long lived branch, schedule, workflow_dispatch, and pull_request into a protected branch
Async by design
Both actions are async by design. A Duku exploration commonly takes 5 to 40 minutes.
The workflow starts the exploration and exits within seconds. This keeps your runner free and avoids spending Actions minutes while Duku explores the app.
Record the build, or reference the target.
Resolve the URL to explore.
Start the exploration. The
environmentaction also starts a test-case run.On a native
pull_requestevent, or on another trigger when you passrepositoryandpr-number, post one stickyExploration in progresscomment.Exit.
When the exploration finishes, results appear in Viewport. When comment metadata is present, the same sticky comment is updated in place with run counts and the top issues found.
Prerequisites
Create a Platform API key in Viewport - Settings → API Keys. Store it as the repository secret
PLATFORM_API_KEY.Pass
github-token: ${{ github.token }}on every preview PR run (it finds the preview URL) and on environment runs. Environment runs onpull_requestalso needpull-requests: writefor their running comment.Add a workflow file under
.github/workflows/.Install the Duku AI GitHub App and link it to your Duku organisation from Settings → Integrations - see the hint above. It is required for PR comments and check runs.
For
environment, declare the environment in Product settings → Environments and store the product ID as the repository variablePLATFORM_PRODUCT_ID.For
preview, add Preview deployments in Product settings → Environments - see Quickstart: preview action.
What to expect
GitHub Actions only starts the run. Viewport is the source of truth for final exploration and test results.
The preview action also gets a GitHub check run on the pull request, which shows the result in the PR's checks list. See GitHub check runs. The environment action does not post a check run.
Read next
Last updated

