Rivet Deploy Action

Creates Rivet namespaces for preview deployments.

Inputs

Input	Required	Default	Description
rivet-token	Yes	-	Rivet Cloud API token
rivet-endpoint	No	https://api.rivet.dev	Rivet Engine API endpoint
github-token	No	${{ github.token }}	GitHub token for PR comments
main-branch	No	main	Main branch name for production deployments
docker-build-path	No	.	Docker build context directory
dockerfile-path	No	Dockerfile	Dockerfile location
managed-pool-config	No	{ }	JSON property overrides for managed pool configuration
prod-namespace	No	-	(Advanced) Override the production namespace slug instead of auto-detecting the first prod-* namespace

Setup

1. Get your Rivet token from Rivet Dashboard > Settings > Advanced > Manual Client Configuration

2. Add secret to your repository:

   gh secret set RIVET_CLOUD_TOKEN

3. Create .github/workflows/rivet-deploy.yml:

   name: Rivet Deploy
   
   on:
     pull_request:
       types: [opened, synchronize, reopened, closed]
     push:
       branches: [main]
   
   concurrency:
     group: rivet-deploy-${{ github.event.pull_request.number || github.ref }}
     cancel-in-progress: true
   
   jobs:
     rivet-deploy:
       runs-on: ubuntu-latest
       permissions:
         contents: read
         pull-requests: write
       steps:
         - uses: actions/checkout@v4
         - uses: rivet-dev/deploy-action@v1
           with:
             rivet-token: ${{ secrets.RIVET_CLOUD_TOKEN }}

How It Works

When a PR is opened or updated:

1. The action creates a Rivet namespace for the PR (or reuses an existing one)
2. The Dockerfile is built
3. The image is uploaded to Rivet's docker registry
4. A runner pool using the image is created in the new namespace

When a PR is closed, the action archives the corresponding Rivet namespace to keep your project tidy.