A reusable GitHub Action to deploy a LiveKit Sandbox instance to a target production branch. Increments the version tag if deployment is
# .github/workflows/sync-to-production.yaml
name: Sync main to sandbox-production
on:
workflow_dispatch:
jobs:
sync:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: livekit-examples/sandbox-deploy-action@v1
with:
production_branch: 'sandbox-production'
token: ${{ secrets.GITHUB_TOKEN }}
token
: A GitHub token with permissions to push to the repository.production_branch
(optional): The branch to mirror themain
branch to. Default issandbox-production
.
The action automatically increments the version tag in the format vX
where X
is an integer. Each deployment to the production branch increases this integer by 1. If no such tag exists, it starts from v1
.