Quickstart: preview action
Start Duku automatically for pull request previews.
2
2. Create the workflow file
name: Duku preview
on:
pull_request:
types: [opened, synchronize, reopened]
branches: [main]
concurrency:
group: duku-preview-${{ github.event.pull_request.number }}
cancel-in-progress: true
jobs:
preview:
name: Duku preview
runs-on: ubuntu-latest
# The action exits in seconds; this cap only guards against network hangs.
timeout-minutes: 5
permissions:
contents: read
pull-requests: write # required to post the sticky "running" PR comment
deployments: read # required for preview URL resolution
checks: read # for preview URL resolution
statuses: read # for preview URL resolution
steps:
- uses: actions/checkout@v4
- name: Duku preview
id: preview
uses: duku-ai/actions/preview@preview/v0.1.0
with:
api-key: ${{ secrets.PLATFORM_API_KEY }}
product-id: ${{ vars.PLATFORM_PRODUCT_ID }}
# Optional: bypass Vercel Deployment Protection on protected previews.
# vercel-automation-bypass-secret: ${{ secrets.VERCEL_AUTOMATION_BYPASS_SECRET }}Preview URL resolution
Example: resolve the URL from Vercel comments
- uses: duku-ai/actions/preview@preview/v0.1.0
with:
api-key: ${{ secrets.PLATFORM_API_KEY }}
product-id: ${{ vars.PLATFORM_PRODUCT_ID }}
preview-url-source: 'comments'
preview-comment-author-logins: 'vercel[bot]'Read next
Last updated

