Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Liveblocks dev server as a GitHub CI Action

A GitHub Action that starts a Liveblocks dev server for integration testing. The server runs as a background process and is available to all subsequent steps in the job.

Quick start

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: liveblocks/dev-server@v1
        id: dev-server

      - name: Run tests against the dev server
        run: npm test
        env:
          LIVEBLOCKS_BASE_URL: ${{ steps.dev-server.outputs.url }}

Inputs

Name Description Default
port Port to expose the dev server on 1153

Outputs

Name Description
url URL of the running dev server

How it works

  1. Sets up Bun via oven-sh/setup-bun
  2. Runs bunx liveblocks dev as a background process
  3. Waits for the /health endpoint to respond (up to 30s)
  4. Outputs the server URL for subsequent steps

The server process is automatically cleaned up when the runner shuts down.

License

This action is licensed under the Apache License 2.0.

The Liveblocks dev server it runs is licensed under AGPL-3.0-or-later.

About

GitHub Action to start a Liveblocks dev server for integration testing

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors