Installation

Let's get you up and running.
1

Install GitHub App

Install the Autodock GitHub App on your repository. This allows Autodock to clone your code and post PR comments as your preview environment progresses.

Install Autodock App
2

Get An API Token

Sign in or sign up to create an API token. No credit card required and a pretty sweet free tier.

Sign In or Sign Up
3

Add GitHub SecretsRecommended

Go to your repository Settings → Secrets and variables → Actions and add:

AUTODOCK_TOKEN= Your API token from Step 2
AUTODOCK_ENV= Environment variables in .env format

Using Doppler? Echo your config to AUTODOCK_ENV.

4

Create a Workflow File

Create .github/workflows/preview.yml in your repository:

# .github/workflows/preview.yml
name: Preview

on:
  pull_request:
    types: [opened, synchronize, reopened, closed]

jobs:
  preview:
    runs-on: ubuntu-latest
    steps:
      - uses: mikesol/autodock-preview@v1
        env:
          AUTODOCK_TOKEN: ${{ secrets.AUTODOCK_TOKEN }}
          AUTODOCK_ENV: ${{ secrets.AUTODOCK_ENV }}  # Optional

Single-repo previews only for now

Each preview environment is tied to one repository. Multi-repo previews coming soon.