Shipfox

GitHub Actions Setup

Install the GitHub App

Install the Shipfox GitHub App

Go Shipfox GitHub App's page and follow the steps to install it in your GitHub organization. This grants Shipfox the required permissions to run your GitHub Actions jobs.

Shipfox works only with GitHub organizations. It does not support personal repositories.

Assign a Shipfox organization

After installation, go to the Shipfox dashboard and choose which Shipfox organization to link with your GitHub App installation.

Run your CI jobs on Shipfox

Edit your GitHub Actions workflow file to use the Shipfox runner:

.github/workflows/ci.yml
jobs:
  build:
-    runs-on: ubuntu-latest
+    runs-on: shipfox-2vcpu-ubuntu-2404

Setup done

You’re now ready to unlock the full potential of CI with Shipfox.